diff --git a/docs/backend_api/assets/hierarchy.js b/docs/backend_api/assets/hierarchy.js index e7c97ca8e..998247f29 100644 --- a/docs/backend_api/assets/hierarchy.js +++ b/docs/backend_api/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJy1l11v2jAUhv9Lrl2WOB9OegcVk7jZKrq7CaE0mOI1JMw2VbuK/77jpBQnIsPB2QVEIuQ9T87Ha/vd4WUphXP7k7ghCrw4QgHGEcJRFCJMwgT5buwhn3gE7kYx3PVd5MeB+rOH4UYcL5DD6TqnmWRlAVLvDvZjdSnSLXVuncm3UlIHOc+sWDm3Ho6Rs+c53MjyVAgqvkzS7JkWq+VDxtlOLsf3s9GSFZLyIs2Xo+rx0UZuc9CoHoFHpVjdKL2b+ocDcoBfizl+FJKnmZzQLEunhWTy7XqCM2IXeODGhuUrTgvILGQDeVEIXyR0kReHBHkJgRx7rg9fBC8UPsE6/isrxYNMJcs+sXEYHbErtHWaXSY/6XQSf4qpLCaEaBj3KReUX5+4olzR5bZc7XMqlkv5toPL6zbHv8Solr5cVg97kUY0h261yogSMEhFs4A4iVWNVBH1vp7wtMg2Fp1dCxgkARpHDzyWkrPHvdVUfWoYhIeWbYVPs82WFtIu/oeIAQCMiw4wpy9MgNlYhD9KXA6uxlQPPpXpjv0oQdwi/EnEBKDhDZPvO2n37rWAQWDoey3w3YZSzkpQs5rAk4yZJeEgDNrWOCuEhNGh9uZ4VOrrCaS2bbVOtuEsFhr1eK+lBXJTYcBK3caYcl5aePdJoxdQ4tZ5iWO9db6WfPsAVU9z9ofyuv+EVfHOKho2FDDqba3Kn9OVZb4aMpdnS22r2hWb0997KuRdWazZk31rN+T69rfvY08VUl01ztlHiIF5u2XNSuoHDcrpCywr0y2T0mb3oqv0mQHYQyE/JNVg+mHgd4DN6ZrCAxkrnsbircjmVJR7bulpDWaTaIb5DaOk4zUaakNMducrnItkik8CE/yBeqVT38AW4KB1qZGtk9rXCoIPKyANT6+PFbrwENXvVO1NTRK3pk7cf1LP4JPK8j/Rt9QN+xXO1zozVYfr0q4DjiJ986gOYFUek0CvfvVejzk9vp+d/bfEzLIUuA1TghNluhXD7jI6NA35PA83qjgk2TVMzZ0a7NCQSuGiQo3iDtsZ2tKvHefwSBrrR8GB7LuPS7ewAr/CwrgTa4gMXrn2nU8h9t32JA8ywVe4i3KVxeFw+Au2qvTj" \ No newline at end of file +window.hierarchyData = "eJy1mt9zmzgQx/8XP5MUBAgpb3GazPjues05ubmHTsdDQLFp+OEDuY2vk//9VsJJJGIXYZGH2LEx3/2wu1ppBT8ndVXxZnL2hXqhE/gUO0HgYweRCDmIYuz4iBCHIh85YYSpQ4PAdTBByPEpCuCMiDiEhvCfOEB86sPvKEi5IYKj8nfwMYy88Kszqdl9zhKeVSWY/DkJAiLeyrhgk7PJ9M+Ks4kzecjKdHLmIeJMNnUOB5I8bhrWfJjGyQMr08VNUmdrvji/np0uspKzuozzxak8/XTFixw05ClwKm/SE6F30n7x5EzgOhWb53cNr+OET1mSxJclz/j2eII9Yj08cGCV5WnNSogAeMPxCIYXil0HuThyEHx2kO/58ELQV4FPkIr/mFXNDY95lrxgoxA/Y0u0+zjpJ3/VOUj8Iia86HkkUjiu47ph9fGeK6uULYoq3eSsWSz4dg1vj0WOvjWnrXR/XL0AYYVoDmlt5RIhYOALLYIodEMRJBFFNbGndVwmK4vUbgUMnACZoxo+57zO7jZWw+pFo9+8yNmO+ThZFazkdvZ3IgYA4HkVYM6+Zw1UGwvzzxIGxmGcqsYvebzObisQtzD/KmICoBWH6ec1t7v2VsDAMOS9YvhixVidVaBmNQJfZcxqEsLY69bGWdlwGDrMvjo+Kw2tCbSt22JC7cJZzDTi9CFzi/CNxIApvYtxWdeVRe1+1RgC5HsuFUC+S9XUuarq4gaiHufZf6xu86+xCt5eRbOEEoxqWovw5yy19Jcm0z+2xPqrG7E5+3fDGn5RlffZ0j61Nbmh+e2HiMhAwrvCOduZGJn3sKxhSLFGefkdppXLIuPcZvWiqgwZA2IR5cACWo5MPwrdA2Rzds/gjCQrl+fNtkzmrKk2tWVR06BNrBk6OIrwgcvQ1MYY2gcvYZ8lU3zimeCPlCwH9Q3qArRffZls7dShtQDvagHVinrbWKjCY0T/oOpgakqjHXX0S+oZ/MW8eif6jrpZvoo2W2Vmor2u7DLgWWSoH0UHJvwYeKEafXlddzl7vj67+t8RM/QSiqjercZFM+4y44CmIZ+P9CiOSXYMkz4+XLGfAy6UwYUKeaDsjF3Sj8WFGaglpdpSd5zyPaRKd7BCV2IF/kGsMTx45Ny334VB4HZH8igj+IjqIqqKZCJYHcvzbLni13HJ8n+ydMl+udFwVVegfXjHpyPVPweHbqCOW7EBeSFMPPLzH3HNrIn2Cw7aUyRizzYM4IVg5HiuGwTCi2Hgk/3k4+Aa+C7SNmJvt2uWXlTFuip7tot6IHShIb6iUSTXAWKfW237qqKIy/RjzOOexO8hU4SGJn8YEbGvTogTkrZvFt+8CeBIoB0xszlM0Glek3nwiZWbER24T9MUT1uSXtdVkTXsj+yhr4vqYVKEhgaV0EDOCCKk6pT6yJLNiNF8q2fmMexi1WOfqk3DPlY/SjlF2yHpWoY4XqB2Zrd1tlxCn5qOgKNrDQ1jFFLZ9GCs3YCQ1ygFp3FjmWS61lBAEUgJSLRV5giOO8pfIpACJ3J9Ne1/+2vD6u1uONlhaVJm2SWCqMD8PRspcorQYD/htp2KcKiiXcVlsuU1M1ws9vB11Qy9RbR1zyhBMw+XPvogi4SXxJ3nt0j2AVSEBqOBlyQa1VbRtytWihbWsmbtVMwCJu7Q78shmZxjpVArNthLkN7yxrar3TNtx7CU/Hz3jSWWleqNnJnfxHMP6h01yIKRwfZKDr7HBL5z6K5Dp/pmRys+K9cbPrI3u5rHUfsIehOfyFInPrxBf538xkPvah6D3gJr95tb8d/Z2HmrKx4Nq3fzKbuPN7lNq7VTGNJjiY5ZskBL+h4sJ57BE0DQ572LbTTIE9CBtw/0YPQuNKHB4yJiO+BdjOM+409P/wNZoANH" \ No newline at end of file diff --git a/docs/backend_api/assets/highlight.css b/docs/backend_api/assets/highlight.css index 5ddd97b2d..5ff0b4d34 100644 --- a/docs/backend_api/assets/highlight.css +++ b/docs/backend_api/assets/highlight.css @@ -19,6 +19,20 @@ --dark-hl-8: #4EC9B0; --light-hl-9: #098658; --dark-hl-9: #B5CEA8; + --light-hl-10: #800000; + --dark-hl-10: #808080; + --light-hl-11: #800000; + --dark-hl-11: #569CD6; + --light-hl-12: #E50000; + --dark-hl-12: #9CDCFE; + --light-hl-13: #0000FF; + --dark-hl-13: #CE9178; + --light-hl-14: #800000; + --dark-hl-14: #D7BA7D; + --light-hl-15: #000000FF; + --dark-hl-15: #D4D4D4; + --light-hl-16: #0451A5; + --dark-hl-16: #CE9178; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -34,6 +48,13 @@ --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); + --hl-16: var(--light-hl-16); --code-background: var(--light-code-background); } } @@ -48,6 +69,13 @@ --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); + --hl-16: var(--dark-hl-16); --code-background: var(--dark-code-background); } } @@ -62,6 +90,13 @@ --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); + --hl-16: var(--light-hl-16); --code-background: var(--light-code-background); } @@ -76,6 +111,13 @@ --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); + --hl-16: var(--dark-hl-16); --code-background: var(--dark-code-background); } @@ -89,4 +131,11 @@ .hl-7 { color: var(--hl-7); } .hl-8 { color: var(--hl-8); } .hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } +.hl-12 { color: var(--hl-12); } +.hl-13 { color: var(--hl-13); } +.hl-14 { color: var(--hl-14); } +.hl-15 { color: var(--hl-15); } +.hl-16 { color: var(--hl-16); } pre, code { background: var(--code-background); } diff --git a/docs/backend_api/assets/navigation.js b/docs/backend_api/assets/navigation.js index e62890e06..500b1eb60 100644 --- a/docs/backend_api/assets/navigation.js +++ b/docs/backend_api/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJy9XFtv2zYU/iuD99puTdJ2azEMs5N0CZa0ge0GG4rCYCTaZiOJGkml8Yb+91E3m5RkWjxH2VPQRt+F93N4yad/R4o+qtHb0YQE9zQJv5sFgqXqu/HN5ejZKCVqrX8X8zCLqPyx+mZRfrPQ3/ywVnGkP7xnSTh6e/xsFKxZFAqajN5+2lL/whJFRUKiX3tRLurPF73Yzx9oos5jpjTIl9/E2mIvtVhEpNRUSobPmXyu1QrU6LCNsdwkwZRKnomA7jwVhH6e9rLabo+Of97v99uzrcnxHReK3EWGqUJ4SQI/X1uiRhO9et3Lx95ifUgV44nE2jvEj3c9pUuqe0DAktWe1sY736eBd48eJ9/T/H/olq0aNEdvXp68cAydb58NQwkP6aLW/01tUv3jMY6Ov0hfeybTYlEwLUom5KBOBdftJ7kY0tKOFOluyYRUp2sirvhXKk6JNHrfMkuCoqsP4rOtZFt/7Wpzs8VFTCL2z5P53AqA7KVESDrhPKLEnIKGtWiJwG2+z+I7Kp7WZaUBMimVFr8RdMken8qjIeFh0ZyBJpkeVOZs2G+FdtirGGGr801e6UO6KQlhZm71OApJ3lrnQvAhXTWYYfaqiobHC4cbERUrBDx5oGWINOcz3VOT1bAmOwRgTstO8iQVaVHD3E218BO5s6hh7v6MozOqvxNFdx4r3Qx3maIDG92nAvPcqssy8gK7667AF29+Onp17GPo9nhoS7fHcFMhXZIsUkY1PRDB8tGG8FWT2rZO+jkqluTmTDLEirrjhYcjJf5G8JgNHYW26IGL/YVS6UwRlclTrbbzSJMsPuTPxtoG+mbeOlwhgZrQICDniWJq47ukdlC01k5TEbMJMcRewyPj0ls3ByH0QLHKDolQvqAktAJyD+0KC4yE9IJAgnWs83FfcQPq6kmT7ZIDESiRTv6JIEmw9iYvYU7mc0VSNueaxZt9B3UqvOeAaslBTtZyBfPmLWFO5il9YBLCXQNd7Ke6QWhEQ9AwtMCwsVAtsL7KFcxVsu7dM8COLqhcs1RHkOHHVKdN3p3NxLpKOCfy/pQnxb88JQxo7xUJHtIPt6G7m/40DciKRdAy0Sk15V9RShp/QKicccE6W7hTJl+3xiFJrfHQX8aAA9suZ5gQyYJTQUNdL4xEoCbs4kFYOmslDn5WzjpzBC8Ll4lU+VwKtVDjURb0LwKaKi6uSUJW8E7SZhrGFmL+6WZC2NKJzUpQKYuFAurIIsGZedzo2XzJIDtWTQqEkSn9O6NS4axYJHgzcx1yyiUXMbxDt5lQtmSq+x54qNf4ASwMUjUtKoSxPGFnAdRLiYbJl4kJbAHeYl2r7ymJohlTkGavobCSlTE6SDYHYkRB3aqGYoTB/ciEYww08ldP/Y4UFiA/g95uaHHgreDaw+AAWllTKhiHGCiRKFnrYpavcvvGlp849qyoiwZoKOIJRax+Ft451fI4z7rOIxrDgjObAFjaPLkGZ6kG2l3SgUSeH/0/Ms3jnSeSOTkgkx/DwmVqtFNEUKIoNr3sYAH2xkwqHutBTGI50+O5uHEDWp07iWCmdJFYwvIZ5cPdFxpARmqTwtUkZ0xPHRJ4lXIHBl7l225Nw2JMC+8qZfeuZ3+dvRufkEuLw9wNRa0673ROckYUuWWS6cz/gkapdebT21E3EdzUbvTAa6mTB2bpd5pooqC4JTxjq4RAUoY2CcpMXeVwJzUDysbF/PoqJ4IHFN1EUFNqsrkMgcuXgXbNItXxJmLpajDAynpZ0Q2yubSfDGhO/1e+IBQ/FYfMtk0KhBGEAbTwlKpMJDo0tw7yvE2YNDhDfzEahWg/BgvMzhXn91k6DsNikzdRYgNw0yaBmckPsMdJ2Dy47+3DwrvmjvzDMkAEqpTgwxJqPaUBFyFYpiY4KMW/QPYOaughelhEWCFd5OCwek8w7XE3EFamLdZVqqJ7nCcBD0ERrgkHX7+1sh94/LaHCXjvlnztvtbU206DAXr9Nyouvco1SyEeDLirF9R3W2AdzUA7RTiHDJ8cBqu8GXlgyQoY2+3ArjLNKBHBGjxBm3C3TKSnEFBQUkOBVTjAuBxoRO5oqqQRZaXiAFopds/NrLqOchC1dIhzKKtDWkRZm5MVPAncgaHi8h6YDddQ14Cd6x+Iwu3QwNLlB8jFTh6J4O3dwQI8ji7j7XckZpERtfd55WBB4c8ZxslG5x7KU7sEIVTFyvOdSY7A6AmymWTLJRVX7J76SltghAulxLvq4YOnBQOJ0y+u8M21pL+BLbTTwZ4rgM19lF5iLTyizAbXexL7FruBRvooI95rooK1mVT0dmLhB/HSfFnqaaXrHSnQyS2JMkjrGGikj9Yjpd4eOt8feetXm4WtxKq3DZtgGDfFdmZ5nfEjqG46edDeyuN5TFVZDAP5GaCyuojg7vIrBjr9tPrFFfNd7vex4H1ZjQA31qLBOCvO9/1XSAMIV6/OMYpM4pqkfg4aYLiLVnzeR707LPdRBRV6gNI+BlEWerZ2BYKr7k4j7OODPuI2Fu7hD+qZc2gASs3zIXeOgOvl80B+IOqnWaMQuuZJiqe4CYU7+BAzzx6VI+B6OgrMH8f4SVYghCoL7j0lNQKhJ3hKhdp4jxoDCFevN80xQWI3xxCeEOHYHhKUq864wNtWJwvCV+MUsZeLroNDL83q3YR3OGMi4frl41LPKbgCHdplaB479v0zHF2njs6/tGH+rYhxyvruF+pPXRuhxGRyeidNopNj7enzf5xlZuc=" \ No newline at end of file +window.navigationData = "eJy9XWlz27gZ/isZ92vSbpxjdzOdTuVDGzdW4lqO087OjgcmIQkxRXBByLba2f9egIcEkCCOF1Q/ZTbRcwDE8eJ4sb/+94jjZ3704egEJQ84T1/ME0YK/mJydXH08qhAfCX+bU3TTYbLvzS/uat/cyd+8+cVX2fihw8kT48+HL88SlYkSxnOjz78uqP+K8k5ZjnK/uZFedf+/M6L/fwR5/x8TbgAhfKrWF3srRDLUFkKKl6mr0j5SqhVqCO3jUm5zZNrXNINS/DeU0UY5mmQVXf7+vinYb9/vNyZnNxTxtF9ppiqhBcoCfO1I+p8onfvvXwMFutLwQnNy1h7Lv5419d4gUULSEi+HPja8c6HNOLdR/eTP2H5N3jH1nSa1z+/ffODpev88ZtiKKcpvmv1/863hfjjeZ0dfy9D7alMd3cV013NFNmpC0bF9yspG9PSnjTS3YKwkp+uELukT5idolJpfYtNnlRNfRSffSXd+nvbN1e/OFujjPznYD53AiB7BWIlPqE0w0gdgsa1qInAbX7erO8xO6zLRgNksuRC/IrhBXk+lEdFIsCiOgKdbESnUkdDvxnaYq9hhM3OV7LSx3RTE8LM3Ip+lCL5tc4Zo2O66jDD7DUVDY8X3B8xKlZIaP6I6xDphs5FS82X45o0CMCc1o3kIBWpUcPcXQvhA7nTqGHu/rXOzrD4Haua84SLz3C/4Xhko0MqMM+9uqwjL7A7cwX+8POPr98dhxi6PR7b0u0x3FSKF2iTcaWaHhEjsrdF+GpJdVtv/BxVU3J3JBljRt3zwsORGn/F6JqMHYX26IGT/UfOizlHfFOeCrW9R5xv1i5/OlY34LvyFuEKSvgJThJ0nnPCt6FTqoGiN3eqijGbEGPsNTwTWgbrSlCEHihW2SMjlD9ilGoBeYB2gwVGQmJCQMlqLdbjoeIK1NaSTnZTDkSgRlr5TxjKk1UweQ2zMp9zVJAbKliC2fdQq8JnCqgWCbKy1jNYMG8NszJf40dSQrhboI39VHwQnOEU1A01MKwvNBNsqHIDs5XMvHsG2NEFlWteiAgy/VqIZVNwY1OxthLeoPLhlObVfwVKKFDvGQke0o+3obsf/gQNyIpG0DNhlLqmT1FKAu8QqkdcsM4ObpWR89YkRYXWH/xlFDjw20mGE1SS5JThVNQLQRnoE5p4Iiyd9RYOYVbOjGuEIAsXecnlWAq10OKjLIh/SHDBKZuhHC3hjaTPNI6tiPHHzBRhSyxslgyXZTVRQB1pJHFmnrdiNF8QyI5VlyLCyDX+fYNLHmdFI4k3cyNCznJB2RreoPtMUbbKQrQ9cFdv8SNYGKVqelQRxuSCnSRQLzUaJl8vTGAT8A5rm31PUZbNCYd89hYKK1kdo4NkJTBGFNSsWmiMMLgdqfAYA531a6C+YQkLkJ9Dbzf0OOKtxH0PhQNoZYUxIxRioEZGyWoXs0KV+ze2wsRjz4pMNEBDGc1xxOyn4a1DLV3LVdd5htew4EwnAJZWLq7Bq1QFbS/pSCKvXv9/ZLrHOweSeeOQkcewcJkWbRVhGHEcu7w0sABb46bkdC06MVqXc9Gfqxs3oNnZSAQzJYpEciJHlC/333EC6aldCtsnOSNi6CiBVyn3YOBVvt3WNCzG1PC2Upp3Pf11Bjc+IZcWx7kbGjXrTMWa5AxxdEtKIlb+H3FWaGc+3o7MRHBT+94DryUjD8zSLzgXREl1S3hOljmCLBn6JFFm2iqHO2kZomx8vJldSiJ4QGEmgpriJ9uLFDh9KWjbKNIcb0ZMXR0GWFkvGrpRNpeGyYDmxF/JCaH6k1PIaNuliDASYSBa+BrzDctFaK4d5AWbUGniDP2b4CyN9qOwwOxcUvqwKSZpWm3y5pxtAW76JDAz8gB7kqfdg3tvHxreNnbIH9YBIlClBrsl+OoaJ5SlYJmWwClFv0P2Dlqoix4WETZIGzk4rB4IpgPuBsLKtMPaSlU1j/M8oSkowlXh4Ou32uoHHr8NMAHv3aIn87UmbzsdBuj136y69FquSAHxoMBtraC92wJraAraKkIppPtIGKzy5uiR5EtgbLcH28o0x4glK/AArcLtMpkYQkBBSQsFVuEI/XKkHrmnaRaNUVYaDqCVavdcXVW3UU5ELbk4x7I6psUoazdoCV8E7sFQ8fIBuBpuobYOeyP+iCjcHg0snTxArnbyUAb/3gYW4HF0HW9P0ZpkStTuk+WgQeHpDJN8K9YePFC7BkWosmVgnolExOgxtD3ZLBaYXZIHHCqtgSNccM6mTeJDoAUFGadfXeG7EZLhBnZQo4OBK4DdfRQvsR4+oswK12e0Di12Bx3po454Z4gnK3VR4e1Ew4/ipZtZGmjFlEcKdHKLsg3k6yjoSB+9JCVvD8b8o2D9ZrOwt7DytqETjOOm2s6srzN+BdWNkSfaW308H1NVGsNIfkaoLBMR3J28YiCWn1q7uCSh0/0QS7wv7SPAjfVoYpxV5/vhM6QChKs35xjVSmKGijAHHTDcRS8+91E3h+UhqqBCj1Da5yTbpIFfuwHBVfenEfrxgY+4joV7+IQD1xwCEKUWmMgtEXA9OQ7IA9EwzRYVoauepASKq1C4gy9rEtiiJAKuJ6JAmRwTJtmAIlRJ8hAoKRAReowWmPFtcK9RgHD1dtM8Jkg0c4zhKSIcGyCJcmWMC4JtGVkifHVOEb1cmA4OgzSbvIngcEZFwvXr5NLAIbgBuXYZuseOvs9wmE4drS9tqG9FTAriu18ofmrbCEUqk9U76hK9OdY8TVkVetpf6Gx/pBLr7sxPydme6DRxKhXtQz9FebLlDOPTTAzOUyqfV5oZXuFwSA3R6B7UlOMdoj4GitHcMwzLDeafO0Q8EtAjqbt3ssclPz4k+ZtDkr89JPm7Q5K/PyT5j4ck/8lGPrU9Z+Lqq37vmUwt75l4KLgfNJkOPWjiYne/aDI1vzfiInY9OCL/ffDxBwe5gvWUmDwhhr+RdImj1BQam/A1Wa74FcpxBpTsEtjEZCCVipBSRFWQFqzDbUJi+XhDbyjN7hEbvOLhUOty2AIZQ58JEDL3Gl3hBJX4H//cYLatdnss980cakYiy8ltiguGExGMpi9sW4afhtPzHYYaqDXF59NnLTYJIf/ci0m6OUopnhH5qo71ZQiXTo/FlTaH8nTwioFTbAd3ZF8tCFufEZTRpe2g3ynX5/HQ/Ub4aobLEi2tz9n4iffJPB3cEJ6NpK9SOZPrnvlMRNDRH9rE5E6GuyT5Q0yZuyTWXC+f1DKHYFBuGUPLiagIRot3IC0F78zugghEPDFSQaGNZQe2luoZJxsZI0S1yz6LTXO3SIRI7cBeClUdgNp8h8JLDTopaQReShGducth1XM/xOW/yHBc+J063+LyXm24lOwvjvgtO1waJOMDd+Rd/BXSym3LXPBZ27i8M5qAhoEKaGMeJWAdP1itGS/yYsNH8dZlGsngJzxO1ek8I5mb0U2JR7HXZRrJYO8mU6gv84Um33w07R6Hv7Th4obWo2aIPcDGmRpp5Zbv+9HckvXpklAJPJQuOF5H6Ei4VUU2rDP6lINDOZ0B1hL2zfsEwZqjzgBNSUwxNNprsfbkulRm+Q2kO3oIVGBX+l5k2NqhcKnNMEcxUi0+Mr3SQ2nP4NKaPxF5cTbtbWeGCXZorDmEmJViUINWpAK3qsBH+6hxvgFDu7YCj9LXL/QH6xuu9AfoFzx6i8lAY89ILGn2GLMq0hns2XVctnjoLrICt6qsxCwjXx+8R8lw6pFLq0tiTUIafJ7HtQtvfJqnm96UDibhueh3aJcGdPndYl38V7TOb4JqtHiXzjXKl+CCVGCrwgrn4E/dYCPyzOoUY3hj63BYS8rIcokZTsHxns4AK/XXi6hgT4HD9G8JfpontACp78C2ev7GCHCvo0Z6HaSZbmv5nqP55Ge1w6T+nbx0VGjc9X8RiE7ytL2+XZC8nxHodxTUZXGWvobFiQaKydwxoFIFdcsox1TtNwrWM3AECZvvsofIWm609/MTAN1EQTpF+ucRfhIDRxFmgaFL6j4i1qvqhsQKSHMP6lnVjyFNfQ/0kviSZ1uwzA7skpL5toECEuKi/QXzfZgH7KpGDpfwRzGYZMEtrUG5yC/RPc4AHXKHcwnMxLhAiowk2v8fzUtDhbpk5HoFUIwW5qKv13rVWiVqrB7kcRmQV/+JCPIC9VoYfMoXvBj3st5di7oK5CrT/PesOZStp4/QYaGHdwnKL/2FVc8CBEopyNCq9LmFblKHXUM3MZnvof/2P86IupY=" \ No newline at end of file diff --git a/docs/backend_api/assets/search.js b/docs/backend_api/assets/search.js index 9e1bbc7d2..65e9939f1 100644 --- a/docs/backend_api/assets/search.js +++ b/docs/backend_api/assets/search.js @@ -1 +1 @@ -window.searchData = "eJzVvW+T4zaS7vtVNtpve30KfyVN3LgRbY99xufM2l53727cOzHhUEmsKtoqUUOqut07Md/9kAAhAcmHEkSAdTxvZrrdxayHZBJI5C8T+PubuvrUvPnDX/7+5tdyv33zB/72zX79XLz5w5uv1ptfi/32X95v6vJw/Jd3P3735u2bl3rX/tNztX3ZFc3/6H/kZ/sjP7c/8uXT8XnX/txmt26aojX85s0/3g5t/z/l/ljU+/Xu/42x+bP76Z+B+bdvDuu62B+x4vMvZ3x5+vXv7ptjvd4cvyo2m/U3+2N5/HzS0Zu+ogNYuFXbl95DOMtU7PyUNtW+/S0vm2NVZ5L3RWhyglRk2n/Kd1ye9N/vqvvvtrmkd9bK7fyqt+tj8XVdtP+bTXpncnMy+Qr6/63alg9l3ht4Ptuc+Q7K5se6ap9YxjdQNgfP5Oz633/eb3KKb5y9mZW/HDd/zO/+rdVX/QL6u8j9EfS3Met3wDVn0htBux/KNoD2xs6qj832X8vmX/1PY467KJs/Frsi69e8PRmc4R3cyXOo8PNjcfy6aq9szWZS35ncnEy+wtsI7qfJfz/N/8X7uS8eqrp4v/5Y7h/zfSidzcbZfOU7eiz2Rd2OM39aN0+57sjZfLI2Z/5mWv/+sfqlyif+eLDmXkf3h6p1pyKz+mPVWKOv7k3H/+gn9af1/jHfGNwadvP6yfDM76f13vfHuv0oMw9grd3G2EWj2Cx3Uu7LbOp7WzMrfl7Xv77LPY93RtevN5cH9/C+fD7ssn3lwZ00zvTM93N4OdofsJ92rntpzRbmrxtn9pXHrCbj8DsYdWdR/HLoBsJv6+r5p+pTtvWGMfrQGq2N0RlWTV5O7Kt3x+N68/R8+7jqXfl7yoFRWRlyX/4zGll7rk8/cXPmayD4bGty3itC8aQs3UAryM71Y0W5fyrq8qaxIkJ1P1X/udg/Hm8Nk5FndMZ2zthMT3p6ZnGgeCyfMuszT8gswhuAmZRZ76DLRGzqz4cMb6DLQZxNzeQx0zOhQC/OgM78vCdlQoF4kAGdVflz+XxrDDJQ3duYyTf27dtMH7c7K3POLtWnfVGnyzRm5tR5qJryWFb7VKGenZmU1tXNy5aByt7GTArbKDNdojMyl8bPh3SJ1sZMCpNYzEDrBQYz6ziaxmLGbuP1I4f+Pt5vnoquTmH7bVV/U6+bl7p4X7YzU6b7apz5LgFtzTe9+XxeloExDcP/q2zpX3K/nkyQCQZ2w4TUzOptwuX7dXrQYS3t15lDD6K3AwnFtg1OD0V9LNvfkKja2jv49mbTfqjL53X9+X8XWZ53b+3XYoZnngdEDiTHAsj8n2weEjm8oUgCOe8NJaBIMJ6OIMisittn9rH93j5U37cPKEMSpTN2rPbW2GyaD7cW6wGpxsZMCvu8QHKG5GRmJp0JoHkgdhQwz/rF5RsSR0bE3Gq/LXdFjkmnNfXQmpp3xml/SY5xoTUz74gwrdwA6UwoM4jXOam8YEwtKCvIrflDtxD/oc6WiGxNmrV9VaeWZMbpTyp/QOovlD3MOtollj+gmDtH2UOE8gnlDsNlGS1zmPVZl03/kN99XJe79X16Pqts+se89izO9LxTijWGWezRIo1Z30B6scblOwFFGrPeT1qxxnDZeUORxrzLngnVGoO7GauNm0lxtrBxZN2ZVW1Kbckwz5ihpmQkW0pqSery/mVS8Ggv/L1VkniqMhWS9A9ovI7E/sAkduarPVlKwmeX1U6uIfGFZi8huaw5rRrDFz4PWLmuPgGqUPkzAJXL+svmO2t2Ymzl30DZlIGteXw8rRYj1DtHKcY19ZMrMULp2QsxLuveT8uW+JoTsyRX9E2twggUphZhXNaYUNvgq8xQ2nBZ50Qm72tMRPKX9SUTeV/pbEA+6h4yTR3z4fjLd/FxvXtJdRVnI5uvZOLqQUg0N1a/dhNl8+7hof1F5f7x/cv9sS7S5+q1M9icDM71ClJqAkLRaT0qMVr301LtdBqZUeFxXU9HAsEgbQy9mtrk6fmsN+8knbMGxNebpQTkmtoMFSC+5owFINeUJ9d/BEFRrvKPoep81R++4Fcq/rhyO0kpuOB2Xqf04/LtJFZ+hDN+lsKPy3pt0Pn1rtqnur+1tOktzaM2sU7BlztTmcI1/cc/Fg/lvthmGG9aY1trbNbxxmnOsW50krMvHjNVKxCt2eOSPLUKRGViqUKUysmVCkBrxP4Hsw7RXSFDrvi1q2CYJ4TNXbpAVM9WuXD5TjIULpBQcbxuYc77mFjGEKwkp2/WEKGvefdyrP5c7n9NX6S3hnbW0Fxas80v3ep89ukltaTCFzxXRcUNdzC5oGL0PrLXU1y+m/RyimAV93rVFJdva2IxhX8vmWspLuu19QSpWWRnZJ5PN7WAYig1vX7isuKP612Z4bl6ZvIBEb/M46t6vd/cvCazV/2uCjw8STmqO/rnkrVYwpeYt1Liilrzr4l6zZ+nJ08vK0wo5PBFzkDjruueyuGo8NwE7rLysvnmt8N6v03TXTbF2coMfpFQsBHKzF6tcU33tFKNUHTeOo3LiqcVQfh60+DKdXU/TiyBoBpTayAuK7VWpjErX6m1M+czPdTtkuu3JI3Owgzq0go1fJXzVGlEqc8xNcxUnzHQn6P0IQgYZq17uCa/DVV22yl5wiCM7IykJAivqZxc3BDOE4mVDddV/lexvjkfFUr8ZC3Mou885OYZcOfSOb04wNeZXhlwTWdqWYCvNldNwFUfSCoICCe1HNUAQ72ZSgF8qa9RB3DlRqYXAQQ38goVAJdvJAX/h7NeOvu/rDQB/AdzWzr1v6zTTkrJ6aUvrJ17Z2cGpSnFCb7SOSoTrilPnvYSEehVfVNQOdGXwsmj9E2D5EDlzIT86s2kwWZyQ/OQ5sv3kIqZSegxC2O+fAdTAHMQKifQ5cvKkvCnL3EW9nmD9mngc/QO8lLPy/eRiDyDOPWVeOflG5oCO/27yEk6LyudhjmDTEwS44xRNxFwDkUm0s1hcstHht8c14fyQ9UauFXo+crfFToksnLgQ+8ZZUWIVGpejHhddQKoo9JnSMrG6Z+alUU3kDste/0OitNPpHuPsXXs/j4dMlxXnADxqOAZQF6M/mkwbyg+L9C7rnxK5zVVnZIFu67QON+UhTeVaQwlnI0XoTUNSVHB82Cp6LvINQjOhKfgfeRAVIMJdFZMFXMbkyHQcHxJBEExaqdDjMHkkwwyYvSmwgyqOhfQiNGeBjWo8jxgA+vOBDeo5NcAHBE3NB1yDG7oFUDH9RtKgR3D8TMdeFxXnJKip4rnSNPH3MGkVPhQfFI6PFrntJT4iNqZ0+JRN5WWGgc3Nk96/Pq9pKbIwYQ2S5r8+p1MSZUPYp6EdPl1hUkpcyp1lrT5jfcwLXV+8U7yps+v309iCn0QFb1SGv36jU1JpdO7yZlOv644KWk9WEjmSFzj5a+fvJ7Cy7trflcJ65OgHKlq80RGkgU///ywWx8/FL8dv15vnqY/uC+soWNraNMbyq51WkL9LDFvKv2SUlNXWt+OT7zXfraQ/Tn2ccC7/fa8SXDT/u2n4mPZlK2/vS//O8ET3Bbq+/ZzP5lv/1Y78401/zr3NcO9zKw/i+K5NCbgobPGGdKi1zRPzYaGonMnQS+pLpuvijZonxibnnWXzX1nJzFzeFnp5AObfZnJRzVf1jgZUfkas8Opy5qnYSlfcF4gdUntlMOYz0pTjmG+pGpa19tZV1p/1iVl3WnJ21P39s1p67NEY2jtG8qu1dqwRSMpUq2d+7OdmZQmS5xFmwuAvq5ebs/qnBU6M5veTHaddt+kn4o2nu/CtelKraHaM5Rf65RjrD2FKQdYX9Q1YZtsT1bCDtmXVKUB7rO+edB2hPL0MG4mnE20E853Gp0TP/2TnZzffg7o7i2yZ8Xtl6W7RXPiU3ZmZnzI3jLqh/tfsqykKmNnJq3uu0sW67672dSWzbu6fYEf08Lm9dnGLBozrOryLuiIwt36vtglfkbGxozfUBhAJ4oNg+i5Vf85w+M1hl7lGbtIMIdgFwy+qubv9pvdy7bcP3bbLqautII7KJ3lXW95hvuxVhIfvjUy41Ov8zjJK/hHPYdrvLpXhIu0xKceLtRmfPZAda43AO7hNd5DuKRKio/CVdVsERJZSuWQPHtUN70o9aw1vRz1ssbUQtSz0lwlqFfmlaTiU29qyVJ2SrUG9Zk/u10yP3w+FGlqz7a6JMtsiqeXyHpSX6E49uJNTC+L9W7iFQpiL93EenteIyQkXrbnxcEc/tLaN2uCJIW73sIc6tyUnSSwPhvJr7Eu3u123U/8uD4+ZUgCtAbXu53ZT7AzmDsjkKtc28+8pRdqX1JptpL5cHOBs5dX6wwcJ5c2X9RW7T+2c+WH6kdjzDv8OqWQojN5rKy+tW8yu/6efSfk1k4GZtDWJZqSyur6PX5S9qG5pLCo103xzW+bomlcDdP7/frQPFUpJNBYLYzVU+mSZzX7XaS0QJxVz9H8cFn10R93U4Qf/fF2nid8fLdv3+exqr83dQGJcntbtkZgbsV5tM6m8jQ8fvU5pd6ik3oydf85W+nFJb0f0hgykZwTKY+rTvSGwM7MSr/6/FOV7fk295/ras7nm7pSsGrnWyn4Kr9uJ6jv9k2x7/a7vr23AIvetEbLwOis95DsyHnLnkZ1/ueU06yx1qRDra/o/aod5d1knKT2vjXkJuNX0Go73rIpbpy5WXQn18F1avMWwVGNX3c1DFmEmmqI11Db/UwGqftqvtEgORs2ktHLp/CPRbNpr167EwrSHuj2ZG3eGPePZWMi1A+Vi3bTZPfmjtX6bG4O3d+Wu8R0dGvkoTUyVx7aamx/tNjmGxEeeouvMTJ823enpQnuO9Nm0vjdJiUv2hooN/PkRDttdrnfTobpw2t5sjXnGPu/mg4Mp4+zvzQdBZ5zrPWUvl8/FLvPufQ2ztocqhM5Q2thNs7g1J1PHU1zWCN0GxibTXMGpbPqS1+/GI1zrl3OOjM8zI/OzhxKfwhKD5PEhoWHr6I37enO0250WXG684aq5/TiH04FnumC5xxpzzoz+MOs49dZaSY/mH0kI4pzPeD5x7R0zO8Ez8n6qdoMzzd3k9pFvZnc2Gme05N/zNT52W0UNkfzJ9abvtaxcuZc50zZLC6UmLBNXIS2aRvEDRSCreHy6cwyXM08UjmNuRY1Tu7865o8w+vcI6tT+cHUf2eRenSm5tSbPgm8xvh/2hMoUenZyhwq7VXf7D8mqWzMzxTGyiwqi66I8KeiedllmKEaY6021uacp95X9bHYOk73U7Gp6kSq0BiLDtXVJ4uzqD/W1f4xYxTTGIOvEsu8f7lvv5y0MaI52ZhRYQ7U1AudlzN5eptT39GH4vmwS9sPIdTfnPqOjp7pOe7nQ66dOlor82zWMVDcVUf9UGfYjKmT3BmrarwpUz7NaTsLB4rn2VP4kv6ndZPOVFsjc5LUTmN6MrUTOWcetbX/dfK+jq2RzFs7Uo098Vvf7wrXBJGYjWyNlmejrhFittxk++vSBc+pLlf2vzU1f/bf6U1/pPNmpJ3O9CW9kzrnur79HVmEzqwxaR/5QOj4DvKZ1E7ZK/6sMGWX+MuqXLdoGzp+SArGz6ZmjMnPv+TDU9kkbul8NnZsjeXc1jnU3PQO+u7jutx1U0yC5Mbt2OvZmkHxuczuhwfzk0kb+Thb1cO+mmcWKJtvduVj2T6Pb6v6a9PZ1uVjPlQ5OuXKpuiNP1T15mT8WM3bM1c231a7bZEQ1pbNg7Mwg7o/ldtttxdZd3rCMak6qGyejK2Nb2sOxcfnhBChVXmcuoP+NWXfPa9vPwnCl1b2BubQ5q3YpuvzjMyi0XpjckrJKDWm5pzFmv/Vjt/2whSpv7RWGmdlDpVNSvjX6mvmifxKu4D6UL8cn5KGHRPtH52ZWXS+7DdPX627OemhTOj/6LR2pu7X3QxkTc2g94dDYqKtbKrDbPm1svmpqpK+mNpeP4MyuxRJjZXsMmSuKCnpNKizzFnOgYrWPe0EqBH1ec9+unQPiac+nfW/1nlPl26mLp6rj0WGFJE1NGuCyP6KxPSQNTJbcsiaT8+4WDtzJl2mnPF11pfzdK9rKnOs/Do78y7yut/gahDSdNZnK/lVmqy4waDpIbY1ZkDonEH2WXOTVXQzs+ocTfrNzE36OTZOG9k3LZ/CLI1WzeyNVk1yy1IzY8tSk6MIsZm3CLGrt0knl52VOdFlZ9/W6SQsrzojh5OR7BqP1ePjLkdcZw3NOgbZX5H46Vgjs3091nz6B2TtzPkN2cNLpys8XT+TsolntFKBiaezEp3Buaw2dXKrQHvVl9Mzy56cTGezepJynM7aPxfvqaWfeepLzHvq6WW1CadD+pJnOFvouu6pRwtR4blPFrqsPOFcQ1/4DCcbXtM97WzDUHTe0w0vK95P2OfDV5uyxcdlZWmnevka5znXK0p9js9vprO9Luv/OKWPw1ed1L4x0JbjNK9g+pj1PK9r8ieflBSOE5lz8ddUF5NPK/BlF8nnFVzTmXpiga8215kF1zSnnVrgK85zbsFQb6ZzAHypr3ESwJUbmZ7SCm7kFU4DuHwjKXuth+Ni+m7rl5Wm7AftK51jR+hryid1N4eik/qbo/RN63AGKkGP8+s5dHKDCrmheVpULt9DaqkymYjGi5Vnu4Mp5ctBjEILmGdTmlTk4EuepczhBu3TCh1G7yBvqcPl+0gsdgiimFcqd7h8Q1Owt38XOcH3ZaVJ6dJgsZkjYTpcWvop06ng2133u0qbBqJyJE5PTydr6jSUmTd5ek3xZtrsN3iyKSg2UuOfi/3j7TuMQ6U7Z2oWvQkp6VDtDImxGO1/XjfHb7ZTysuH8tvrWjspVeYxiqdm8oZ6cyfyrqlPSKaH4mdIp1/XPi2hToXnTalfU/1c3p7DCRX3Fmbx5q6cKXUGsRtazKXQFbWlqnR25lN6nHLITigy6WSdq/o+H1LlWQuzqEtDPKHOeSBP5B3kms76m5h/RkvEU1D1K8xrOTAQCYVnBUHXb2EyCqIzXOaMxXXl03FQKD0dCF3XmoqEQsW5oNB13WlYKFSdBwwhzZnQUCj3NeDQ1ZuZjofIzbwCILp2MymIiI6Z6ZDomlpzTGmWTJE98TS1T+Ka3hSsFcqdA2xdV5941CW9hUzHXd6oe9KRlxel5w7OLxwomVF31hlpXPG0IzAv6U47BjNCfZbRPP24swilCX0sA7UZelluUzzt4KBLutMOD4pQP6WHeyA4pYU7QuOU8oOBxpQChEiN00oQoNK0jdYj9KZVGQw0z1NncO0+UisNBuubLBujXVM9pbqALHsz1hdcVZu8oRddsufa1Oua8qTaCJKXnqM64ib90+ojLtxF3gqJa/eSWCNBlvSvVCVx7aam1EmEd5KzUuKq2kxhYHor8zWlSVUdJEebo64DZZW9yo5t8bB+2d36VPurfk9VHb6kDDUd7rmM5OLXu10XfL5v3XLCzpaB1taU2ayg9cyEfS2v6XX9vd/tt8VvSXKdpbK3NKfaWxfYWOnUpfUVlffTDnEINCae23BFoWmSt53sHyp75kTSV9WZs8qO1b0zN4Pu4rg+lB+q1kDSwzVmjs7MDDp31Xp7c3QWSDxZmEGdGVVSxDkDM2g7bz03WV3a7nVDfcEsvt5uJyQXwuFnu01ILVzRty029efD8VQk9H3qu+4NnkLPvO8+1F7Wx8+5Zk9jbJb5M9D80P6nyafWBoI7SzPMTBfU/ld5fPqxLh7KpHk/1P2ptXlwNme4gy5pfQqxUmR3uepTgDWf1qk7mA20pm5hdovWH+oPT/XNi5RxyVV9fJq+UrlFedIXmAW7RKmdtDcP0Jq0Nc8NSrM5hDU3tz98tavuE7XeWxMz6UuOuDuFeeNsrLFLV5h9ud7t+/VCFtVd6sIsGtb7ft0w833kcWArfm7vtSnFRKmFMzKTxtNCLFXnaSn2ClpTZ4c51o0Z0CWVOd/qoteX52vqZM79LSUvf3qd873vSXuOUYmVMzKPxp+KTdGfWN5NCP/+UtSp41NtTJpH200Gf+tNzqV/UunZUHNS2Vm8zjzfl5M79zd2On85n2/0Bl/BM24/jGCgdvp5BFf01f3SdLK6Ouva1qdD7w/rTbH9jyk7TvqX/p440UBXBlgUPKaxjOJuV32yP9IlZKqX4ySaPJRvDFtU+MkaBmQ5772UzbvdrisX6tYLH+ry8bGo8zjJF2XT3k9Hlrs1w9GaTtqxNOZ+ms1TsX3ZFZnuwZmbXfcx66N/radtf8H31afvHr5vw4OmWd88lQzFW6P76lP5sPeMZrwHf1z8sG5+NfUIv906cHtX/p5GRSorw6DoP6PxHu1bW8EGQnsbMynsIldTxNTGKX9qR6RdUffj3c3cb6C8s73tbT9Z20fPdr47IgV8XbtlU/xYV49t4NB8Xb3cnO0Z3IozeuiNbnqjM91DXRzaaPebuk73c2uq6E3NpPfY/sj7l82mKG7HxQPFnbHGMzaT5jbk/a4dArrD1lMVt6bKs6mMepU+yfWoxsHDA8bEQzueXxMdXp9naA53Rdhvdi/b4mu4aUmKzC96yzn2MCFP8dqj9ivcJtxCe/kMD/rMdryWqAR1X5wNTm6KCh9Z3C5BKZLBZkGZxdINglLUplVk3iI3/bOjojN9bhekw41sUpSP9v3nFm5qtTN5tDU2r08P+/pTFOP2/uySh/sEpYnG2wVllh1stpOiN2HPnSih1ad9UWdyYWNrXg8+VE0ZcIYUvZ6x2QTXfjNqitiEHtQooeGmQSlKU9qTo6SO7ROTIvrSdjHzyH/fJ9G231b1N/W6eamL96W/GMlwOy5Rt+32RrC/oymnr1LGbo8Ez7Y4ZmrsfLp6ntC57xKY5jWhNq9VIMFhzk9rdArsj70P2vsSZJuD5T2DcwnfrydOgkRvwtYwUTKrXP6QtAFdjNSk6Y+ITZ/9rsoNNnpLkJqw3VuMzBzzCVGcbTq5Kj48EydBcsrZOCNC/XnB1q9NmhROl84wI9hSuCmff6iqb3SavqvM6fHkX7sRpanrtgip3/x2WO+3WbQWZ1OziJ06+hOhaXuPxoj8cfLYD6QmDv5XBVs73+d5ttbYvE/4EPaPTJaa0jJyVWTyREXU5pmlkGx/5P96V+2Ln4rmUO2bCTNVcPnvagYYKkudBcJHNZZb6uD/Y5Yn+cXZ1mxyzdi1npKUBnrN2LWenI+OEmzYYzMBsQG9Z1s55QZfl03TT4OC3sUzfFkPVb3pNorofsf2p6JrBU6X+IWx+tBbrZ3VSY/Xe3SXbiHYNypReMLGUVjuHL7wr+yfwBt6kf+M/hBI/+fwCP7P4BH8/5ZHfPtiy0Uzyn+xVaK/e1fm/3SuLOZy5fSHKV7xYX4s6ukP0108R47+5VjZ39BMWu1SdV90Bje+wYmP9PTA8CP9Y7vy25tF9Q/3vxSbCZUj1MIsRVrdY2hjyt16Wi4BavyiN1ufzU55xoMneKkm4LmalAsb0d9VBTiLc0rfre+L3YdJaXGs3BhMyI/HCn9+2R3Lw67c+C29idqJzTnl71+e74v6x7rYlNNGFXwH1uzBMzvnTTgffbcr1xOGbXwLzui6N5r5BvwR8tzAPAkDBJfPMDaeN+WakgwaqvO255qcEAofWX40AFSn4oEoydPQMFCbwIajhJrXF5yfkKLWWBucoZBZ8sgBVim6L5xjNY/46SnucfWJae4x+f4I9z8Lc1DFtLDau/h3W55PNeaszfcfHn68HU96t9+SbWeixQeXz0YScuj6ImlTnPAxXUjLZ5GasEvHmFD6zn9c1+vnCV/U+drfFTcislKhkfeEcvcyUKVpjQzXhaIThCeLTZ+xrgsuH/dVXXxb1ffldlvs7dZS6Z76hbX74OweTnZnuo2Eio2B9NSSjRi5CU0BQ72pHQHXBU9rB6BKE3oBrkucWgdDRSaVacTJnF4Jg8QmlsJcl5xWC0MlZyiGiZA8sRpmIDalHOa6zOO6fiwyTGsnOzPJLJ4PO7MjRB4XcPZmdoKJHSEDtQntIBEiJ+VSBxqnJ1CvS0xdj1OxWRbjUPYw7j4+/dSu7erJqt31cyxom3d1GzV/nP5IA3Hdxjxne9Mf6emJjcr+kwnpcol+ctbmlPzd/k9V2R3//f7l/kNdTP7iqPhy/2TtNi/3R2t3vtuYXoiGxCdWoo1KHnyD/vF6tylur5xj3Tuxiz+QlNbAf3ousy0jTzozjbRXxE5Pdw7VJqY5r8lNgA2h1lTOcF1o6iLRk5pliXhBbMIC8aQydXl4QV7S4vAkMD1evSAxJVo9KUyOVS8JnB6pnvUlxqkX5GWJUk9C88Wo1yXnGjzzYCIgmk7pk+h3f+HvbELPsyGPeyhzpK8zbcJzRWJyxBFsXpP+2cy23c5Aa4bPZZYtdkKhaZvrXBGZGBJlq7y4KjMxIMq4ic4VqdPDoRwb51wRlxIM5ekXvSIwIRTKsonLNXmTA6EcGwJcEZcjDMpbNhMnONOIni8GGi+SsSdFTAqCTpfOkk98/3m/mfIEQ1Xt6Ng4Q1Me3vnxZK2dIyIT6uauCkx2SaI1j1NelT1xJw0iNmUbDSTR/3Jc2X7zVB5uF+pfPcP3Y87Bmoq4BtrsWbxJs2TwtGZhs0PVGejsiOzQD+zBIpPGUO/i39FikqpKW1D6D2ieDVMHenNUQEbITlpoDkSnRyeRkv+8bo7fbMt8qluprbFyVuFJC6aB6vRFU4TkaQungdaExVOEyKkLqIHMxHH2qlB3gFMWsc7YnIInrvwGWlNWfzEyJ60AhyqnrwIjRKauBAdys6wG44VnHXJ77a8x6iavHsbEJ64fsHQ/LHu//ljuH6c1f5yvnSEoa34tD/+53pXbiU2/RNwXnb2Pvr0pz9N7WiOPs+gKcqbW/vtXz5EtMAXafVXM95N6KQYK+6rvviQmoa8ieHKX+4FcDVV3CzmesmsIcrVU+2r6oaMjt+H7SHduyh/9Q5ailbsr51gJV9viu2dz7M72XfN1+7dEeV90Fsve4rrZWItTHunpeY1GPIddq+4/9tuibn9PXTTdWX7mwLAJ3hHeRG/75Wy7O86vcbbnuJ1m/dC/iVTxnaXSWZpF6lNd7n/97nn9mP6kra3S2ZpDbndS0dnHP/jnxE0U3Vk8+3h/8lwm6fxutWDqfI7cab/aYCuGLp68pjm4Ms/YQcXZg/nqm2T112QS5G/nfigjX2z7k7f++jHn+vnnQ11+XEdPqu5Xf+FfGP0Mulsc24vmt7KK/RpPItxFOQRsnoqiLmMLQE8SzpdlEfFSuyzpzULspbfGMhfEbNeff7n5lbiLcgjYVY//ZnfNvFlGe+nz+dJMYvzTPKcoMhPw9uV0fQ5ZVV0+lvtv9sf43WJOkuy1hbs2h5zmb7tbVdhLsvzy47qe9O2YCzN+Ob897/jtn87pqokSgjMX79uffjl8H40tTirshfvbTn+/IMQmYbooYdKoZlM47dVprwdI+r74NF3RvviUX9B0Nbml/NAfBP3n9cu+neHqabKq/gDo3dlKPoldIDz9iXVBb8anVuy7A38M3Gze3TetiW/r6vlHa+xGgdaWSbg3a2ProbV1cLZyy/2xXR22Nr7bp6s9WFPlPq/YZrM+FH+y8e5t2syVtwbql6T81i2a3tsOqg/V/18evi2jKcBZlrHS92Edq/8uDw/lbQzggsTH4vjucPhu/3BzJPvYbaJ1KO2VuaScjrGaosa/OJ8gu6icpud0bSY5N+2v42u5fdeay0L+uP48ZTBtr2wD/owDaWvwvPvTBDXnjeDmEHRzSBcoyhXaecdpfx9foOZrckdo31qadlnUv1X749NEL3rurs3rRxOV5BdhErt/7nYPnSjHZG93vYGMwlJ1zSDL1uVN0FMdbgVkMUKmfPDV6cpMUv79pV2dFvVEf/6bvTqvWztCO0FPfb40l5iqOn693rXXrKc+pLo1selN5H1SH6rt5Kn1WGWfXP+rKH79tqybhAn/U2vioTMxi7gEUXnF/H/FZG/6XGT1ol31OCHZmOmXt3Hmtnp+30a++5tV2Gsbd20WOS/7H/buIIub9bzsq/3D+eJcgl6OTbktfnjouhqmaLLXVw+NvT6HrMYA/W+rSS5sL36ocjpxIOjmaTVQlGtqbWwU9KGalvlobBDUzvc5sx1NZVPYtz+iyqawcz2dY/X4uLM5oompIWvBpIbyZoSO7cDSrDddmLW+OXalF+cQ9LKfnqRy16alqcQZaq89jvxxXZfd0dNQwnoKRv7r2/bGtsVvb/7w9zfunI8/vOFfii9X7aUPZbHbtmb+4lqnNtVzn8DZVpsX88e/9j/2n8XmWNXdD9uf/h93b97+5e6taC0t5Fvm/sDf8tWX4k799a9v/+LMmR81/8FZPf8XY4q1fxNvNftywcML2eBCFlzI279JdCEfXMiDC0X7N/VWsi+FEMGFYnChCC6U7d/0W3n3pVwtgwvl4EIZXKjavy3QhWpwoQou1O3flkiqHlyogwsX7d9Wb8WqfTiL4MLF4MJFcOGy/Ru7eyvFl1yGj3U5uHIZXLnqrmTod64GV65CF+g8gvG3YvHlgoUPiA3dhxH/6byCibdSfinUKrwYuFDoQ6zzDCaRaDZ0Ixb6Eeu8gyn4m4euxEJfYp2HMA0vHroTC/2JdV7CFvDioUux0KdY5ylsCS8euhUL/Yp13sJW8OKha7HQt1jnMPwOXjz0Lha6F+t8hjN48dDBWOhhvPMZztHFfOhhPPQw3vkMhx7Ghx7GySjV+QyX8GIwUIUexjuf4dDD+NDDeOhhvPMZDj2MDz2Mhx7GO5/h0MP40MN46GG88xkOPYwPPYyHHsY7n+ErOLAPPYyHHsaXY2M7HzoYDx2Mdy4j7t4q/aVmLLx46GA8dDBxNzY3iKF/idC/hJkC2Vt1196xDi8e+pcI/UvwsblFDN1LkIlQjE0vAkyFoXeJzl/aUAY8LTH0LhF6l1Bj05MYOpcInUvo0RlKDJ1LhM4lOncR8FMWQ+cSoXOJzl+EhM9r6F0i9C5hvEvB5zX0LhF6l+wcRmjkIXLoXjJ0L2nca4F+sxy6lwzdS3YeI+CnLIf+JUP/kp3LiBV6VXLoYJIEW3I0npAg3godTKrRiEIOPUyGHiY7n5FwIJBDD5Ohh8nFaDgihx4mQw+Ty9FwRA49TIYeJjufke0EqVrZPLx46GEy9DDV+Yzk6GI19DAVepjqfEYKePHQw1ToYYqPRlFq6GEq9DAlRqMoNfQwFXqYkqNRlBp6mCIhfeczEq4/FIjqQw9TxsMUvHjoYSr0MNX5jNTIPdXQw1ToYWo5GvypoYep0MOU8bB2JOm+Z/Kehx6mQg/TxsOWSLYeepgOPUwbD2tHksWXd2Qk0UMP06GHaeNhMGbVQw/ToYdpE4LBmFUPPUyHHqY7n1FwJNFDD9Ohh2kTgsGAVw89TJOFownBYMCrwdox9DBtQjA4humhh+nQw7QJwRhyEj30MB16mDZBPoyW9dDDdOhhCxPkw5FkMfSwRehhCxPkw5FkMfSwRehhCxPkw5FkMfSwRehhC5OP4OiBLYYetgg9bGGCfPg9L4Yetgg9bNH5jILJl8XQwxahhy06n4Gh9mLoYAuSnehcRkn0XSxAgiJ0sEXnMjDUXgz9axH616LzGBgtL4butQjda9k5DIyWl0PvWobetez8RcHobzn0rmXoXcvOX2C0vBw61zJ0rqWZIHE+Z+hcy9C5lmb40mjUXQ6daxk617JzFxwtL4fOtQyda9n5Cw54l0PvWobetTRBPgw7l0PvWpL8l5kgYdi5BBmw0L2WJgcGw87l0L+WoX+tOpdRC3TPq6GDrUIHW41nwVZDB1uFDrbqfEYt0TiwGnrYKvSwlfEwGLOuhh62Cj1sZTxshb6L1dDDVqGHrTqf0XdQ9tDDVqGHrTqf0QxePPSwVehhKxOCwVB7NfSwVehhq85ncKi9GnrYiiRZTQgGQ+0VSLPSPKtJtOKM5R3KtJJU653xMpy0vAPJ1juSbb0zkRjOW96BfOsdSbjedd6jYdLB/hu9nuRc70zEj1OfdyDrekfSrnfG4zCtuAOJ1zuSeb0zTgcXDfbf6PUk+Xpn/A6Gwfbf6PUk/3pnBjecvb0DGdg7koK9M+EZTuDegSTsHfE/k7rXcN3DUKZ/kOo3QRrOAcNkP/E/k8DHUTFD+X6a8Dc5fBwYM5Typzl/k8bXGt8/8D+a9jeZfL3A1wP/o5l/k8zH4TVDuX+a/Df5fBxhM5T+p/l/CwDw+IEIAEUAlgHg8QNBAEIBmEns6yUKtRngAIyAAGZJAB4/AApghAUwk97XMLfNAA1gBAcwk+FfwBmPASDACBFgJskPY3YGkAAjTICZND+MvBmAAoxQAWYS/QuY52aACzACBpjJ9cPgnQEywAgaYCbdD+N3BuAAI3SAmYT/Ai7TGOADjAACZpL+MIpnABEwwgiYSfvjQJ4BSsAIJmAm9Y/DcQZIASOogJn0/0LA2we0gBFcwAwBWEj48gEwYIQYMEMBFgr/fuB8hBowiw1gXM8AN2AEHDDDAkYYNUAHjLADZnDACKYG9IARfMAMEVjgqQMABEYIAjNQYIR0A4bACERghgss8NQDMAIjHIEZNLCAawwGSAIjKIEZOoBDbgZgAiM0gRlAgKNuBngCI0CBGUaAA28GkAIjTIEZTDASegOqwAhWYJYrjNQLAP8jZIFZtICnTsAWGIELzPCCkdAb4AVG+AIzyGCBpz5AGBhBDMxQg5HQHUAGRigDM+BgJHQGnIER0MAsacChM0ANjLAGZvDBSOgMaAMjuIGp8WwwA8CBEeLA1HhCmAHmwAh0YGo8J8wAdmCEOzCDEkZCT0AeGEEPzNCEkdATwAdG6AMzQGEk9AT8gREAwQxTGAk9AYJghEEwgxVGQk9AIRjBEMxyiJGqHeB/hEQwAxeWOHQELIIRGMEMX8ChI6ARjOAIZggDDh0Bj2AESDA9HvoBIsEIkmB6PPQDTIIRKMEMZ1gyOPYBLMEIl2CL8dAPgAlGyARbXAj9AJtgBE4wwxtwGpcBPMEIn2AGOSzx0A8IBSOIgi3GST4DkIIRSsEW4zCfAU7BCKhgBj6MhF6AVTACK5jhDyOhE8AVjPAKZhjESOgCkAUjzIIZDjESugBswQi3YIZFjIQuAF0wwi6YwREjoQugF4zgC2aQxEjoAggGIwiDWYaBh14AMRihGGx5IesHOAYjIIMZNjEy9QOUwQjLYAZPjJU9Av8jOIMZQjEy9QOgwQjRYAZSjEz9gGkwAjWY4RQjUz/AGoxwDWZQxcjUD8gGI2iDGVoxMvUDuMEI3WAGWIxM/YBvMAI4mGEWI1M/QByMMA62Gme0DFAORjAHM+RiibPOAHQwQjrYapTUMoA6GGEdzOCLJU5aA9rBCO5gq1FeywDvYAR4MMMwljhnDJAHI8yDG4axhAtnDpgHJ8yDG4axhAtfDpgHJ8yDG4axhAtfDpgHJ8yDG4YBQx8OkAcnyIMbhAFDHw6IByfEgxuCscTVuIB4cEI8uCEYuEyUA+LBCfHgd6ONDBwAD06AB78bb2fgAHhwAjy4ARi4XpQD4MEJ8OAGYOCsGwfAgxPgwQ3AWMGonQPgwQnw4AZgrCDl5AB4cAI8uAEYK46vB95HgAc3AGMFhy4OgAcnwIMbgLHCXT4AeHACPLgBGLh8lQPgwQnw4Gy8lIAD4MEJ8OBsvJqAA+DBCfDgbLyggAPgwWnbgwEYKzh4ctT4QDsf+HhZAUe9D4PmB+N/ePCF7Q/E/wzAWOHBF3VA0BYIQzBWePBFTRC0C8IgjBWsT+CoD4I2QhiEgZcOHLVC0F4IwzDYHR4AUDsE7YfgdgDEIwDqiaBNEQZjsDs8BKC+CMI9uAEZ7A6PAYB8cEI+eE8+8CAA0Acn6IMblMHu8FcA2Acn7IMLW0SF3RjAD07gBzcwg91hPwb0gxP6wQ3NYHfYkQH+4AR/8L5rAk/kgH9wwj+45R8MeyIAIJwAEG4BCMOeCAgIJwSEi/H6dg4ICCcEhMvxEncOCAgnBITL8Sp3DggIJwSEG6LBGP6SAALhBIFwOd5vyAEC4QSBcDnecsgBAuEEgXDbVMHwlwwYCCcMhFsGwvCXDCAIJxCEWwjC8JcMKAgnFIRbCsLwlwwwCCcYhBusgXMRHGAQTjAIN1iDMTwSAA7CCQfhloMwPBIAEMIJCOEWhMD2AQ5ACCcghFsQwvBIAkgIJySE27YLjkcSgEI4QSHcoA2cz+EAhXCCQrhBG4zjkQiwEE5YCFeWBeMvGcAQTmAIt10YHH9JgIZwQkO4snEhrKDmAIdwgkO4ti3XsCKZAx7CCQ/hhm8wrhHQ4ACIcAJEuO3K4LAvjQMiwgkR4YZwMA6RCgdIhBMkwrV1ROzJgIlwwkS4gRxMYE8GVIQTKsK1zUxjTwRchBMuwrXtNsOeCMgIJ2SEa1uWgD0RsBFO2Ag3rIMJPKYDOMIJHOGGdjCBx3SARzjBI9ziEYHHdMBHOOEj3PAO3NbEAR/hhI9wwzuYwGM6ACScABJuAYnAYzogJJwQEm6IB+6t4oCQcEJIeE9IRpqugR8SRMJ7RIK/BMBIOGEkfGE7H/GXACAJJ5CEG+jBJP4SACXhhJLwpS2QEfAhAkzCCSbhFpNIPCYDTsIJJ+GWk+C2QA5ACSeghFtQIvGXAEgJJ6SEW1IisScDVMIJKuEWlUjsyYCVcMJK+NIumLEnAljCCSzhBn4whT0R0BJOaAm3DSAKeyLAJZzgEm6bQBT2RMBLOOElfGWr9PGYDIAJJ8CE22YQhcdkQEw4ISZ8ZXtysScCZMIJMuG2KURhTwTMhBNmwg0DYQp7IoAmnEATbiAIw00tHFATTqgJX9mCLeyJgJtwwk34ylZsYU8E4IQTcMINCWG4R4UDdMIJOuEGhWBwyQE64QSdCINCMLgUAJ0Igk5E3y4CvwQB2Ikg7ETYfhHccCEAPBEEnog72x8OvwQB8Ikg+ETYjhHcsiAAQBEEoAgDRBiu+ReAoAhCUIQhIgwX/QuAUARBKOLO+iH8EgSAKIJAFGEhCi5bF4CiCEJRxJ1dNMMvQQCMIghGEXaDqAX8EgTgKIJwFGE3iVpgTwQgRRCQIuxGUQvsiYCkCEJShN0saoE9EaAUQVCKsBtGLbAnApYiCEsRho3gZnQBWIogLEXY5hFYhiAASxGEpQi7dRQuYRYApggCU4SFKbgGWQCaIghNEZam4CJkAXCKIDhFcOuH+EsAPEUQniIsT8FleAIAFUGAijCAhC3xlwCIiiBERRhCwpb4SwBIRRCkIritpsFfAmAqgjAVwW36Bn8JAKoIAlUEHy9lFQCqCAJVBB8vZRWAqQjCVIRlKrgkQQCmIghTEZap4JoEAZiKoJtNGUSC91gQaL8puuGURSq4qEGgPafoplMWqeCqBoE2nhrsPGXdEH9JcPcp4oYWqWA0LtAOVHQLKotUMBsXaBsqug+VRSoYjgu0FRXdi8oiFUzHBdqOiu5HZZEKxuMCbUlF96QSNkDEnoy2pSJMRdiuEgx4BYAqgkAVYSAJw4RXAKoiCFURlqpgxCsAVRGEqghLVVbYEwFWEQSrCGkr+7EnAq4iCFcRBpNwzGgF4CqCcBUhx9s6BcAqgmAVIcfbOgWgKoJQFSHH2zoFgCqCQBUhbVsx/pIAVRGEqghlFyr4SwJURRCqIgwk4ZgxC0BVBKEqQo3vACMAVRGEqghltxnCXyKgKoJQFdH3l+AvEVAVQaiKsA0mmFELgFUEwSrCdphgRi0AVhEEqwjbYoIZtQBYRRCsIgwlwTvpCEBVBKEqwvaYYMYtAFURhKoI22SCGbcAVEUQqiJslwlmxAJQFUGoijCQhGNGKwBVEYSqCNtnghmtAFRFEKoiDCThmNEKQFUEoSqi3/cKezKgKoJQFWH3vsKMVQCqIghVEQaS4F4dAaCKIFBFGEaCC34FYCqCMBVhd8HCjFcApiIIUxEGkeAtrgFREYSoCANI8GamgKcIwlPEYnxLUoBTBMEpYjG+KymAKYLAFGHYCN5bFKAUQVCKsM0meHtRgFIEQSnCbosFm20EICmCkBRhSQqsGBQApAgCUoQFKbBiUACOIghHEQaL4F2IBMAogmAUYTEKXlwBiiIIRRE9RYH3DyCKIBBFGCaCq4QEYCiCMBRhkAiuEhIAoQiCUIQhIrhKSACCIghBEZag4FgMABRBAIqwAAXHYoCfCMJPhOUnOJAB+EQQfCKW4xtMCkBPBKEnYjmesxYAnggCT8TqQs4asBNB2IlYjW8xIwA6EQSdiNX4FjMCkBNByIlYjW8xIwA4EQScCNtsgtcCgJsIwk2EwSAjawGATQTBJsJQkJG1AKAmglATYSDISCANoIkg0ESsLsy9gJkIwkzEys69OAgF0EQQaCLvRudeCZiJJMxE3o3OvRIQE0mIibyz7neHt4oGOzYTYiINAMGbkUsATCQBJtLwDzj5S4BLJMEl0tAPzmGvrQS4RBJcIu9Gj8yQAJZIAkvkeL+JBKhEElQiL/SbSEBKJCEl8kK/iQSgRBJQIi/0m0jASSThJNJusMVhv44EnEQSTiLZhf3CASaRBJNIdmHLcEBJJKEkkl3YNRxAEkkgiWTW/2AViASURBJKIu3pGnjncUBJJKEkkl3YPxxAEkkgiWQXthAHjEQSRiLZhV3EASKRBJFIPl5lLQEhkYSQSD5eZS0BIJEEkEg+vp24BHxEEj4i+fiO4hLgEUnwiOTjm4pLQEckoSPSHrzB4fpbAjoiCR2RfPx4FwnoiCR0RNqWE1xaKgEekQSPSItHcGmpBHhEEjwiLR7BpaUS4BFJ8Ii0LSe4tFQCPiIJH5EGd+CKQAnwiCR4RFo8gmvJJMAjkuARafEIriWTAI9IgkekoR14uxsJ6IgkdESK8Z53CeCIJHBEivGedwnYiCRsRIrxnncJ0IgkaESK8Z53CciIJGREivGedwnAiKQHdshxQifRkR30zA6DOXAYL9GpHfTYDkM5cBgv0cEd9OQOAzlwGC/R2R2DwzvMMgQPg/D4DuJ/BnHgVK5EJ3jQIzzk+BFEEh3iQU/xsEiEwyymRAd50JM85OhJRBId5UHP8rBIhMMkqETHeRAkIi0S4TAJKgESkQSJSItEOExCSoBEJEEi0iIRXF4vARORhIlIy0Rweb0ETEQSJiItE8Hl9RIwEUmYiLRMBJfXS8BEJGEi0jIRXF4vARORhInIftstHA4AJiIJE5F23y1cXi8BFJEEikgLRXB5vQRQRBIoIi0UweXxEkARSaCItFAEl8dLAEUkgSLSQhFc3i4BFJEEikgLRXB5uwRQRBIoIi0UkXhZC6CIJFBEWiiCy9slgCKSQBFpW01GgioARSSBItK2muB2GwmoiCRURFoqIvG3ALCIJFhE9oeD4G8BYBFJsIi0B4RIHJkCMCIJGJH2kBBcYC8BGpEEjUh7UAgusJcAjkgCR+TCeiL+FgAekQSPSHtgiIQt7RIAEkkAiVzYBCE+HgsQEkkIiTTEYyQ0BYREEkIiF7ZaAY/qAJFIgkikQR4cF+hLwEgkYSRyYfcixOE9gCSSQBK5tCfVYE8GlEQSSiKXdksk7MkAk0iCSeTSxofYkwEnkYSTSMM9OC7QlwCUSAJKpAEfHBfoS0BKJCElcmkdEY/qAJVIgkqk3ZcLF+hLwEokYSXSsA8c4wFUIgkqkXZfLlzfLwErkYSVSLsxF66vlwCWSAJLpIUluL5eAloiCS2Rlpbg+noJcIkkuET2e3Ph8ATwEkl4ibS8BNfXSwBMJAEmcjW6J7oEvEQSXiItL8Hl+RIAE0mAieyBCf4OADGRhJhIS0xweb4EyEQSZCItMsHl+RIwE0mYibTMBJfnS8BMJGEmyjaa4PJ8BaiJItRE3dndWaEjK8BNFOEmynKTBUy4KMBNFOEm6s5uEofP9APgRBFwogwJwcfPKkBOFCEn6m50c34FuIki3ETd2aJqCI4UICeKkBNlUAgGRwqgE0XQibob3aNVAXKiCDlR9miSBT4WEaATRdCJYuMbpCuAThRBJ8pu1YUvBw5IwImy4AQmnBQAJ4qAE2XBCQwIFAAnioATZUAIPnFLAXCiCDhRhoPgU2YV4CaKcBN1YacuBbiJItxEsfH9+RXgJopwE2U4CD70VQFuogg3Uf3RJHAeUACcKAJOlAEh+Ew8BcCJIuBEGRCCI0IFwIki4ETx8V2CFQAnioATZUAIRo8KgBNFwIniFxwQgBNFwIkyHASTQwW4iSLcRPFxcKcAN1GEmyiDQXDhlALYRBFsoridhWEcoAA2UQSbKHtACR6AATVRhJoocWEABNBEEWiiDATBB6QoAE0UgSbqwgklCjATRZiJunBCiQLIRBFkoi6cUKIAMlEEmagLJ5QogEwUQSZKXHBAgEwUQSbKIhPcnKYAM1GEmSjDQEYcCDATRZiJsswEN7cpAE0UgSbKQBCON1pXgJooQk2UpSa4uU0BbKIINlEWmywFfAaAmyjCTZTlJksJvQCAE0XAibLgZKmwAuCGhJwo200ydgvADwk6UT06GbkF4IiEnSjLTsZuATgiYSfK9pOM3QLwREJPlKUnY7cAPJGehm7pCe7QU+hAdHoiuqUnI88AHYpOT0VXlzwRHYxOT0a39GRMAfBEejq6pSe4SVChA9IHJ6RbT8QzGjwknXiipSe4SVChg9LpSemWnuAmQYUOS6enpVt6gpsEFTownZ6YbukJbhJU6NB0Qk+UpSe4SVABeqIIPVGWnuAmQQXoiSL0RFl6gpsEFaAnitATZekJbhJUgJ4oQk+UPbsETwsAnigCT5TdpwtHNoCdKMJOlB6v6VcAnSiCTpQhIfgADQXIiSLkROnxXYQVACeKgBOlx3cRVoCbKMJNlOUmuElTAW6iCDdRlpuMZFcAN1GEmyjLTXCXpwLcRBFuoiw3wV2eCnATRbiJMhgEn1SsADZRBJsoQ0EE7hJVAJsogk2UwSAj0RnAJopgE2WxyUiCB2ATRbCJMhQEVvYqAE0UgSbKMBCBu1wVgCaKQBNlGMjI+gIwE0WYiVqOJ2gAMVGEmKjlhQQNACaKABO1vLA+BrxEEV6iDP4YWd4AXKIILlGGfowsbwAtUYSWKAM/RpY3AJYoAkuUPZUdN/kqgEsUwSXK0A+Bm3wVwCWK4BJl6MdIignQEkVoiTLwYyTDAGCJIrBE2W258DAOWIkirEQZ9CFwk7ICrEQRVqIM+sC7mSuAShRBJWplU9Q4EgCwRBFYolZ2EMSRAIAlisASZWHJSCgAYIkisEStrBfiqQzAEkVgiRo/zUQBVKIIKlGGfOBBFIASRUCJtoeZoDFEA0yiCSbRd+PNdRpQEk0oiTbQAw6hGjASTRiJtr0lcAjVAJFogki0RSRwCNUAkWiCSLRhHngA0ICRaMJItD3MBA4AGiASTRCJvhvv7dQAkWiCSPTdeG+nBoxEE0aibXcJ7tDXgJFowki0Pb8dea8GiEQTRKL77hIYgmgASTSBJJqNdhZrwEg0YSSajXYWa4BINEEkmtmaVoiYNGAkmjASzcbXIRowEk0YiTbMA39+AJFogki0PcwEf34AkWiCSLRBHiOfH0AkmiASzcbnXw0IiSaERPPx+VcDQqIJIdF8fP7VgJBoQki0bS3Bnx8gJJoQEm0JCd7fQgNEogki0ba3BHaXaYBINEEk2iAPvI7VAJFogkj0BUSiASLRBJHoC4hEA0SiCSLRhngIvD+HBohEE0SiDfIQeH8ODRiJJoxEG+aBg2gNGIkmjEQb5iHw/h4aQBJNIIk20AOPwICRaMJItBjv7tSAkWjCSLQY7e7UAJFogki0uNDdqQEj0YSRaDE+AgJEogki0eLCCAgIiSaERIsLIyAgJJoQEm0JCW6v1ICQaEJItAEeI0MoACSaABJteMfIEAr4iCZ8RPdnmMAXAPCIJnhEWzyC2ys1wCOa4BFtzzDBQxCgI5rQEW1gh8D742hARzShI9rADoH3x9GAjmhCR7S0dTJwEaUBHdGEjmhpR0G4iNKAjmhCR7S0oyBcA2lARzShI9rADoH3p9GAjmhCR7SywyCeCQEd0YSOaAM7BD5DRAM6ogkd0QZ2CHwGiAZ0RBM6og3sEPgMEA3oiCZ0RBvYIfAZIBrQEU3oiDawQ+BOUQ3oiCZ0RBvYIXCPkwZ0RBM6oi0dQRkhDdiIJmxEG9QhcI+TBmxEEzaiDeoQuMdJAzaiCRvRBnUI3OOkARvRhI1obf0QOzJgI5qwEa3tkhg7MmAjmrARbViHwD1OGsARTeCINrBD4B4nDeiIJnREG9ohcI+TBnhEEzyitZ2VsSMDPqIJH9GGdwjc46QBINEEkGhtt13AnggIiSaERBvgIXCPkwaERBNCog3wELjHSQNCogkh0QubnsaeCAiJJoREL2x+GnsiICSaEBK9sNkZ7IkAkWiCSLRFJLjHSQNEogki0QZ5CNxhpAEj0YSRaIM8BO4w0oCRaMJI9MIGiNgTASXRhJJoS0lwh5EGlEQTSqKXdgcQ7IkAk2iCSbRtLcGtahqAEk1AibbHmOBGMQ1IiSakRNvWEtympQEq0QSV6KX1RPwxAVaiCSvRtrUEN0lpAEs0gSXatpbgJikNaIkmtERbWoLPQdGAlmhCS7SlJfgcFA1oiSa0RBv6gdu0NKAlmtASbWkJbtPSAJdogku0wR8Ct2lpwEs04SXa9pbgNi0NeIkmvESvbE01Hk8AMNEEmGgLTHCflwbARBNgovvduPCnAICJJsBEG/4h8EkuGgATTYCJtsAEN4ppAEw0ASZ6ZR0RD0gAmWiCTLRhIAI3imkATTSBJos764nwW1oAbLIg2GRhMIjAjWILwE0WhJssDAgRuNNrAcjJgpCThSUnuNNrAdDJgqCThUUnuNNrAdjJgrCThWUnuNNrAeDJgsCThYUnuNNrAejJgtCThW0wwZ1eC4BPFgSfLAwOEbhVawH4yYLwk4XlJ7hVawH4yYLwk4Xdngu3ai0AQVkQgrIwQETgVq0FICgLQlAWBonAJdsCEBT33/769k25/1jUx2L73X5b/PbmD3/5y5uff37YrY/H4rfjZr15Kt68/fubn0v7r0v51vy+N3/4+xvWDgh/+Ps//vHW/abub29Pv8P8W/dLf/75UJcf18fAULc6PFnq1n9xlj6ud+W2NXX8fCjM1Z7J7gTek8nujN0ok4/FcVPtj91/820p7z6FvVZx+/+sHUXsH6Tu/9BGSuYP3cm85g/d7p3mD902VFE6GqzDe0pM9jqE08GcjoXTwZ0O6XRop0NE6VjfN8d6vTneF5vNuv2H8vjZ1+O9/rj7Wm/b13Wsy/uXI3lZwn9ZKtbYbn1f7EJDvib7RmIM7atQULeTxslOt1dGpJ26aL+VstqHmpSvKe4zWe92nabOD+hXx/2PpdsQJtJe9enl0H0tn8rjU/Vy3Dyt94+h4XbmOhteRt70oQxsnC3034W2T+/tm26UibJYF/3dH9bHp2Zdb57Kj8U2fKTaf6SRSo/H9lF2/6kMjIk7z9aq/6ru5I02q8OxCR7EwnNpZT/OG8zV1afQmvKtRX697lPbVC/hQLLyPZLf3WYtfHrK++AWCzc23mrS2Ap8fOF/fzeaGzw8z1jXkHeTsfCttutdT1f0W7WmunkqnPakP+1FjlYvx6qdG9ppuiEDTVeDf75PFTmK/lZWTSjKe1pdKjXGyv1682uxDxzjjowEUTZeDvvw3XXJtrOaRayl03cUPJ+V5/Vxw/A9nK6U92kv4h7z/X293m+efCsL7wmxyAnZTMTBSOhJYX0E4AKAlYsIRD8Cs0U//3POXETQj9LdBqNxAh6qumjWH8v9Y6DDe02sj3aUdKGJi5WkE7IULjRZOSELF5rEjbz3xbGdeo5V63ZBSOo/VB1palfdh4OaP8H2+vrntHB3wPubZNqFfav+n7qDEuytuJCs68K3f3A/09VM2T+IuEnxnkYoS//FryKdsJ2k6JjBvDGjO2Aiys7Al7uS+/PQs4h0ZmOGDrArf4CNfDjGUPgKF8z/urSbmNz87j4JtYgbde2vGEws/oDL48KQ+7r4WA6GbubddrfXeIyl9tkVdVmFg/fSH7zj5qf20e0GEfDCX2uIWEG9IRJgMe9daH6DrUMbC+6Pxwo4nB+1SRXncMZmTQYMf20X/eCtnWFc5YelkWu9za7aF+2Qeqj2TRiOL/xvSsSNz8baMfAJ5o/NPDKW2lTbonw+VF0uYN10fwvf6MoPXCLdrL3BY/2yOVZ1MJl6jt9PCm7B4EZW7iYS7QbdlXZjrZu/3DJcujlGnmaUVdw0ABbcXRHr2cvcNNbtidIPHgs3nEc/gu5XrPfbc4TStH9zQ0LTlP8djvK+Q93FvjrwSwaGfZ+IXJ30hnfF/vH4FLqD9w5Pk59LlNy5hyQiv1L7awYLKn/GU9K9C3kKNtyIHjlp9L9m8GCW/oOJNtVlzYaK/XWHivbCztaxogOylL6x22zZcRRHxcyPAHj0t3wIM0H+8jRuRt20y/x2adqNV0Ho5WUQmPMhFpnlsDZbv1/Tp9cxd28dEXmXxty++DS05o9/i0gvsdaoKXnnm4r8RIypqrYJnd36pYuj6tCsP+cuIn3PmO1SvUOV3DcX6X4vded2A1t+iNdVysTY6t5pmKvyEwSR8W/3sHoXCUIdz3f7aaUfXRYrNwO5nKru/8Cda4oFdwOedLOCG4lWKzc9cDcExr0IT2h1/0sQYfjjduSi0fpI0xoryZ13Nbre/KacyvjH+Vxty4cytOp/af1D6h+WW20yN8UzvXTP0y20FsI9TzfL3rlFk5vjNYu/cSeQPkd/0Itccm7Xn38JUyV+ENqVbEVZad/s50MwBEtvllfOwSKnsd7coW6/sk37ek3WOIyU/dVsJFvZFg/rlx2JhfyUeGQau7VT7stu0dk+/1ZfOD368W3krLEtdu0ABZIpni0WGeNaW+Fahfvrnm7zuN7hIj3EWKQDHvOjZR65VtmW9fHzKALws2IyMkdX7JuX2ogrm/V90/7TQ10929AgHOuFP9bHvRff+KFdzbT/Vu6RbT/juYhzosKAJwr4/AnOZZFWbph25I25sZiLU6LJjdeRieCiXjdF8dumaJpTmL5fH5qnKoz2mL9W4JHRnjEOEwJ+aljyuAG5aDbrQ/F0fN6Fz1z5zzwuS3HOroXfx9JPq2iXTYlMtJ2N0kSKv3BWkQPp2RoZ73zHiH0Pv3VL3ebl/lgX7fL5v8vDQ7kjEZCPqBdxvtMOftsRkODHozIyUROa6zhe+6k9lCE58UNTGRldPVT1pmhHg25F1DHMah0Oij7oV+7bUg54q8jo3P6Wl92uWX8MhzN/masiR29jbWjJX4g47q1cRlwpl5GNHIUf2+i/bqOIp3UTTDf+mom5x+BiGhfKMPfb2FK6Sd0FmEuXpeBx4+tj6+0eFA0HHuYPPLfaa+eX4An66xEZ+Sl21vbt2zhWtU3/EYF+KYaKG/Q9k8SYXyoQSeY7Y4dDuX8Ik6XSZ0vLOLfrTGG6FExIun/jehn3aQdm7z+Hgy7zJwOuVs514p+kZ7qdS8ORjfmBHdcujxaZzg6st2PoIEfurxyljpvIAqPk9fsZMe2STS6vL3W8+59/wf3nuqLPxF9naRcyiFt8BJS5+Nl5rt1Cx60p9TJutPbNb9r4ody34VbTRtkfyW/zw87IKdq3Dd+m8N/mLS4CJkEWlF7c5BvW2sf17iW8Z3/y5/HOcN8ONG5wDe35Q5eO/uB8e00rlsBS4Y9h8U+xA5Xh2/CDxEh419kZ4hQ/RpQuqa6X0cM/YnlM+MPWrfK6xYkBLev9driQ4H44JiPzeSfb0LP9JVVkSq8z2I7Vg8Svn6VRkUULXelhd7v4SfpD9I0GBxkB5mcEePyzA4DEf2huXuKnjJiINr1dfx6mHP080jJ6+DIph2JLl4va5+V30UPNOYERGPMLX++iR5ltu0BrA+y1zYnSKMlf0/PIRHBntGxMpHSsXLwUWvWnnMg88GOXxKDFntx/HzJeH67T6LpuPGunaCn6xYyt/pQfvi5cRnMZ/Y66dd8g1eB74p3z8miprclju8jfXvi8g8qkeK19YXZgy4/feWSGpbVVbkjVqh/O8sisQWdn/1TU7QezfxyOO34oyCOX0Mak9fAwT+fZUpFk1LNFX7Hw/VEvox/bL021R5XafpzET0VWkcU+od1m/VDsPofW/YnVlZvLSL7aWh/WTfvzP4+PQ42h8xhJXrc/zcSHEsYmseQPjfFTgbE0jBH9z5nHjzhna0Sc//HGDzTP7dt9Gkx6/vClI0uwW2MDWOx7s8tCOBDP1GmC7sdd6Uotuva+G34liqOUvwyOH3+G3EL5C8f4AcgY6nJjAycXvrSuD/EGiyMGfSq6io52QBmeX1IqHXbsOhVvMhnSKd9m17MYa+rTvhhp0/C9k8cPkqHF8Ovx3wmPd/jQ5PAb998Mj3dqY3Y4OvpPksc7ztkauWd/+L7BbU7mwP364/cNbhOaJDL98ftG/4GNMMofxiOrsqhBItEfyiOrAKhF8DD9EX0VPaLbVSoM8HTQYxL94ViLw0DKb9Thq+iP5lD9ElYG+tDUJaFOfW0unX3qMHNdbHx1Ymku7RZZMdBrOFaDvL1ftu1w/6mzzVVhnArKXR+bcBUBYnUKsaJf199e1nUblw+nYB9RxntpXWzcu+pSF397Kepw/eTblfHZZvgl+VVSIrJ8z7M1FrH5i2QRWfzmmSXGpG8sevhwxo7r+rEg7Y9+rWhkh5Zncfiha+0bjPZhCGz9EVi6mFzHj0nOKIyp/GRXfHR+4tXhTS/8m47+XE7GRrzbT5/FB/t1VYV5PX9El/Ghfmdns9512RXwRfsAPH48bzZ1eWhXYB/Dx+c3TNxFD+VN0TUy1kXzskMDul/+fxc9oDemPtslmtsRqKpJUslvMhJ30XFQ0z7Q/eOFCW0RlPxGD2Y9YQ9N+WNZZCH12RTKpPmtlyKy6zS02JT7ze5lW+4fj8XzYUcrBtnCH9siq9Ha32DHNOqf/rDG4p+lNYbHXr9dVEQWL3UmOzZY1adiMt9msDLtJ2LBooe3Y4VyvP7ApuPjopfjxpRImhbmsFTBr09xyyjXNeAa5JjD8Mz1CAgH8cXqlE2JVvOpKH59KOsGZrH9cVHHh2qdzaEtPw8Z2avS2vpcoDHRG3EWkfmzp3UDc8x+zZyIbCTsbME1pt+sK1jcA2uNod4e5vdnich6r67Uo9i2n8ChqI9lOOzJIOloDbiWPuaqTZhbvnPpolPX7igjG6NbDX0edX2/K1wH/HBd6lc9injbQ0N+26TgcWNwa+hCqsAvFBORrVDOItDnzxGRZc/OGgyg/WYSEVn/2xrEtvzJILJUr7VluTDsOvJWdw7Ful4oV0rO1Gm7kd4BBT+NYaf8XtznUz62UWfX2HtfbrdFX7YZ5pLuvNepIlP31uxTVTZ9kBJY9Ldw0JFbONhZ+fRBDOIo4be66ciytN7oaHcT9yd7dWoCi+SmrfW6WDdFO6A8ttFfM+gZ5H7sJyPnwG71Flb9eS7j1h4u3eu2rGGutpy5dbtwfQ1i5UaoyFbPct8tnddhOtSbeiONuB18UFzol/KJyGqks8XjU9kM6qaZX2goIjtRzZZIXZXu8NPvzhz0Chcj312zfnhow6v24we37c/xkXm81qCtqexKJdpB5fGx6DuDQj/z8+mRKdESbr/iN3tzfuptjxuWW5Mvx2pX7n8NYmC/3TgyYC2b+6J9iLboPqxS9gVGrutbd+kbJz+uy1037wavxUcHbsAVp57TuKm3bPpujVCtX2PkiAyPXJh3JmGFgr8fQ2SU3tkaPEp/QyU397hWy9WpPc/19biGWH6ai0500qX1lNv6QLnHp1yArt2GCfoGxa6konoY9F34/ZcishilbIpd+Vi2r78rMD7ts3KsRron/X5REcl329/x26H9Vkkbmt/5eN6owFUsR2YMy+ah2m3DZkDmfw8iEhOXzZOJBsIwwC+vjsyNOkPtTx069yIs2x9CRWR/XGuSNDmwlR9vRqajy6Z8Xod7YLGV/zFGJpNLP1oPRg3vcbkPQUWG1yej5Htc+ZFr5CLV2DIvAU20Kz9+jQ0ZO4s2sgMmu7PfPD+JfRu/tEOvTbqF+vxAIDY+aboKitCMP/dHj9hmLXKsX45PxG39sUXGvlLbqnu/7kaWhzIsCvVbEkXkhoVlA8Av8+dnIWM/9zZCfa5og6j/WanIantjaphA8hMO/eTQj/uuJYuJ0zziqqxczYJwJWLS/RfFTiOjmzVcbK5dNkdHf8CDPPSdPyzJ2GHJrukGuwn6qycRub1ha+zzfkM+fk+UC0L6W3UpBuYmDOa2IeKO5AlXDidPHbWRK9+y+VSsg3jNz9KwSPc3n9Jg/cP8J80jexrsV0m2U+P+2K0iO127Xifi8348JiO3WthVwccsfOC7iAR0rY3ndoXYzkiky9iPPSPr+FtbzWHduo9dCBCDftlKZNn987r+dY0CxKA3xX2Ajti6D5GdmqMcqBXylK1wX3akGwVK2hn8EM65QTdL/1G44YSxUwmUU+jyvUKelsLuK4kcg/t3Fmjw82kqcsp6LklJoj/Rn7YdcMTd/UG5oFy5UVS7rQn0ielHhgnPL7tjediVG1r668ccKrLdmFZY+ql+1w/HXKm4cAVoyrmQchkvHZlRo4Oun+B2LqYiC6A7W218jvY583f8iuwS6KwZd20n6qfW7K6o+1U6+ZJ8tCgjOSXYbssP5/rPzpVuMLezBXerMHlajrmPRYmTRzlHch2N+lybERcKWDRZr59JNtH/PCILqVF7DvezzMqtQtUNj+7MTUOBfsovMg1jzJEKm+4IYs9Q3GdoDTWDNb2PNZk4vS33h0hY3lkn9QXdWbHnCSGSEoONJvwaxsg+1P3L831RH9pXMKyo8NclKrJF2obDg/vzy2Ej8QEIrLn/acnIdF/Vfurlvhj0Uwj/cenIVrUQuIBYyi8Mi8yZXqjO9NfmPBLNnwkOkOeTjcj0a8BwgEk/8x3Znzk0ecL9XV4yXEz5QwGPTCJ1v6Amo7K/iD3N3XGuOF6H4S/PeGSlg7UGnmQQON1ia7B3pN8dHxlFnS2RfTz9/KPLjqrTH9zEpiNfPWBb/qqBx74RMDwH++z0U5ErVFSn7fojV1zDjR0WwSEELul++kNk48GhLtv4+fOvxXA/FT/G64NiV+jJ5Klgwi3M5WkHYRe+R+a1XJphvSvXpGsy2EQu0m1e+lY1tJ299157kW5NzFwgw1w/F3PQVLjstnCbTMrIFEr7fW6r52G7r/DLdReRZZUXRjz/viKTudGDnV+hHZmMPVUgPZWHEMb6FUORk1FdPFcfC1hSwO8CThI3e1h7g4IC7k8bInLHEWsLckB/khCReyjWxWHXrtBfWhN1s+l21e6aTMyqnWzI7j/HyG3BWuNdbWBdh6U63K8HlJHlSPVgjxB/bSUjO6hc/ehw09yAXcf6nDVGNu/yKyekyw/qyPW3s0mDR/8gGR0ZAND9JIL9ulzeMhJy1S/7au825wnHFe6PK5EjQWvt5diU26J66BKMoUF/Y/vIAuuuPdHuFBw6rZ+0itxtZ9AVEGxc3I/gLlfsqvvYqb/N4Ujh+tuE2w9MRiZwOwEju7v40ZG44X5grbg/hIvILarsnvt0qwHhHwCgI1PLTRtGbl92BSoS8NdwkZ1OANmcjUSaMDU9D9WwTtHvIlhEovzAWvi4/FrbRSRjt+ZMaIr4GfcnTRGZLz7bbEaM+jQocjFtjYJ8i38CkY7curEZ2cSG+4tpEbkIxudZ+U16i9PHu3TfbOyTHGvC5n4AIiJ5QAO6o7m/gb2IzH82ttDbbb4ceqH2vTD6EcLQw5+eRGSWpHlqY9RfDfwmoYY/18UOTL+Wh77qiq6I/OIRHXkaV9fTgIp5uT/SicjlQWcMDAIL//HHBUGdJbB45P4tisjt0nwyE46+fnQWuaJr/hYW4fk5Kh25Y1FzXNfDfZr9lIWO3KWoedl0O2WGSVofy0VCnmH3l/DDfxXZfDzScOE95sjihLMhclKMNzJEpp3Dvg2wvvN7WiMrWYDNS6s8vzwuEpFf6Dbx87Q8Mqg9rptfzZD9GymG9ZMokRWFnS26P7jwd2jUkQu8zpBx4IIi4UWw2WzcTOI6hwCh8VefKrLpvXtU5xM56IMTfgWwjgxCBlsBBpuSnkiRS4OcSON5x0vXYXPaOvzUcxNZYHOsHh93I+t9P2oRkdzb2gMzuB9xRyJva8vGfWgSX/qzSKRPGJN4HvejyEgcYPY/onuT+sMtc2GVipwJjvV636w3nTpS3O2XqS8iu9QuFCP7JCVyC4TB8Xl+FsLtMO9AuWPf8nxg66lQ2fVU3J0Qs/svkbPTy35kq2U/vbKIBCbDp+N7FnPamOvMF5Gv0trtunVpO3GwC6W92pVXMdc9wE7t9w6ei1Pds2t5kpEhnVWyrz6VD/uiCw/WpHnYX5XJSNxqjYaHXvi1HzpyaeJ6CYfnQvhRvyu76J+F67lhrvyKuQfIXWZZLE4eKN03uHQeeKpYO+264P5LJC4JVZPDDZi/8OGRxR+9xbGDIvy8gDvgT0cmxnvT6KwIf/VyKklwZYEuw+OqX5grYONumhFuf3d5mpPch69Oh765d6T0abpyZQyngiX3wzoyU0RuafACfC4XWSvRm3TJmW130GK97rbV77qRQ1YT7NHsbjzu17gGmWDA8TcCiWzWG+ym4He6nqq8XC+k4idPj3PH3553nJ624XeMxWwn+te3bw7loWgD4Paav/z1H//4P1jRMPg="; \ No newline at end of file +window.searchData = "eJzcvWlz4ziW9/tVJsr9Mrsm5d0TN26E0+mcck9uY7ur7zMTExWUCNmspAg1Qdnpmni++8XCBSBBkcI5h07Vi55pd4p//Q4EYjkL8L8/5fxZ/PRv//2/P31Lsvinfzt881MWrdhP//bTu2jxjWXxv9wt8mRd/Mvl15uf3vy0yVP5Tyseb1Im/rX8yG/mI7/Jj/z8WKxS+blFGgnBpPBPP/3fN13t/yfJCpZnUfr/jtH8rfr0bx75Nz+to5xlhZ+4+fLZ4Xn99ZdzUeTRonjHFovoOiuS4qXmKKUHODwKu7L9bDVCg3kya1ppwTP5LZtFwXMkvANXMgDVJ2238tvD45p/nvL5TYyFrtSSmJ46jgp2lTP5f9HQleSilpyA/xOPk2WCa8Cq0SS2IBFfcy5bDPEXSMTakiTnv3vJFpjwotIjJt8Ui/f43V+qTvoGlFZgvwSlGaTvweHp4ezYGkHVh9AG0FKsoS5E/NdE/NV+NSisSMR7ljLUtzmuBQl+g7fHzVLhtwdWXHH5pJRFoleSi1pygl/DsUfg2yNe0Z45W/Kc3UVPSfaA96IoTVFpTmzRA8tYLseZXyLxiGVRpfloNInfGdm/v/LfOR58sTZy03Dfc9mdGDJ9wYURnbw3FX8vJ/XHKHvAG4OlcDWv18LEv4/svXdFLl9K5AFM6gqt6xvFSCxJsgSNvtQiJl5F+bdL7HlciUbTzeWODXfJap2iveWOJaKSJrZnvSnMB8yrjWWLlGX6z0UlO/GYJRCH386oS0K8WauB8EPOV7f8GW2/oUWXUjTXogS7Jssn9u6yKKLF42r3cdV68kfygbWxEHxfdhv17D2j+hM7e746wI1WsN9rBHGQl67D6vHOlWNFkj2yPNlprBhBXU7VH1n2UOy6TPb1DCWWVmJELR3uWewQ9/lTSNsc4Fn0GuD1pJBaoDwRi/xljfALKB9EI0XUY8I9oR5evweUuL2DPKEeeI8HlJR8lax2XYN0qEsNor6RyV8TPm4rFcrZhT9nLIdjahlKzjUXSZHwDApq6RCR5nznbUuHstQgIpSrTDhiJULF+LKGIxoNIkJQLKbDuiUGQzqOwmIxfWZMv3Io7bhbPDKVpxB/4Pl1HolNzu4SOTMh2SUqeeWANvKilMfrZQgxpu7yfzC29C/YPw9SkMm7sOs6pIjpjcPlcwRfdBilLEJeerR4VSCBxXJxumZ5kchvAFIbvbWtR8a+zpNVlL/8B0Np71LtGyNoc5xAZAd5bAAS/5XFiUR2DRoZgaQ1CBCK9IynPSFIVGLZZk/yfbvnn2UDIThRlFjBMyNGxrzeNVnPg6o1iAhLvwDYQ1LLEHECAs0d2N4AM+kbhzck9oyI2LQfkpRhTDpSaimlaGcc+SUY44KUoR0RwtINfJyANIPxnEHpBX20nrQCbOZ7tRH/kqM5IqWk3tvzHJqSOY4flP7go9+S9kA62gHTH3xrboy0hxHkAekO3W1ZO82BtK0TUTby5VOUpNEc7s9KRNnMkaVI1N6QZI2uF7s3SYP0F4Ana2y3xJOkQWoPLFmju+3cIUmDdtsTkK3RsaYvN46IGG3Z2LPvRKWF5JZ0/YwIOSU93tJWLkmezDdBi0fz4I+WSWJRISWSlA3Un0diPhAUO7NpayVQ+Gw7bXAOiQ2KnkKynRmWjWGD0wRWhukBQZU2PkFAZTt/Im6MbODayjYgEYmjRdPHYbkYLi9FKsYQfXAmhouOnoixnTsL85bYzEAvyQBfaBaGQwhNwtjOCMhtsCkRUhu2cwbG5G1GYEh+Ox84Im+TkgXkR9mANHXQheO3W/EUpRtoV6k00PoKUlzdWRJRh9WHjEjE5XIpvyjJHu428yJn8Lk6qgRFLUj1E0ByAlxoWI3KGNYszNXenkYICYsoDw8JOIO0FpqMFjw9N7y4kzRmDojNi5ICMkSLkAFiMyMmgAyRg/M/nEURVvpHlxov+8MGnij5Y8AckAvOMWea1I/t5gAzP9wZHyXxYzuvWXRepTyDdn+jtCiVaGiBeQo2LlGawhB/8Z4tk4zFCOONFIuNGOl4UzFj7BsrZPTNI1K2QosVfV2Ck6vQogSmKoyiDM5U8LCOOP+AdIhWiQxY61eVwUCzhMVOXWhRk2UubLcEIXGhtVTsz1ugtCMwjcHZSYYf1jCCT1xuCv4xyb7BN+lSKDVCVKxo84vanZNPL9CUChuYKqNiBwuCEyp67UDPp9huDTydwtnFTZdNsd2swGQK2xbkXIrtvCafAOpFrkRoXl1oAkUXFZ4/sZ34KUoThHa1ZPACInaax7s8yhY778nMUz9UgoeFhJHdUbYLarKEjYibKTFAq/8VyKv/e7jzdDshIJHDhiSIxg1zh8bh2uDYEbjt5Im4/r6OshjGnQjWqBD0C0DChouJnq0xxB2WquFC4+ZpbCcOS4KweWHBlWG6r4EpEG1GaA7EdlKjEhazskmNDmWbrnO55foOYqwUCOhgiRo2JU2Wxih6jKmBKD+jw4+R+uAsGEjzHobw5VIljUP8hM4yUolAHIRDlMHJDe48AcxsGKb8B4t29ke5iM9GgYSvGXJxBlwqzvDkAJsTnhkwxAlNC7BpsXICBvsAKCHAndQwsgG6vEipADbqFHkAA4aEJwE4hkyQAbDdEEj435314LH/7aSAwL8zt8Gj/ts5zaQEdi8dGJ15pUNACklOsEkpMhOGyMHTHjAEOsgXEipv8UHi5KP4woLkHkriCPmgMbBgc8sgmkjzdhugYebW0oMkxrzdgpAAs7NUBkSXt5OBwp82Iknscwf2sMBnrwW4Uc/tdgBDns46daJ453aDQoKdthWYkc7tpGFhTscTA4pxjqELDHB2IYHRza5zyw4ZXhfROrnnUmBX0ObJHyp02MLCCB9abYQaQmyj4oYRh6kBgbo2OoFTdhx/qFfWZwC2W3bYAlZ/At57tFah/g4PMgwTA4J4bWCCQN4Y/rBgXhceN6A3TB5Sed2mhnjBhgl15wvZeLcxtRDgbrwRrLCQVBuYJiw12gqsQZAoPOW1AyNE1ZlAScNUY8wIDgJ1xxdgIGgMbXgQozP5gAMZY3ihwYw2NVZAYww7LKjRJscJbPi5kYIbbeQpAhwjDAoPcnQMmiDQMWwQJNjRHT/hAY9hYoiLvk1M4aYfY0GQK7wLD3KHj+YMc4n30BK7xUcZBXONewyjcY8P2wJ1kXsmNBI3+bAlIa7yzpoH4C4fJgS5zNuoJG7zHW0Ic51vtQTXfT5sD9CF3lkVTeRGHzYsxJXetgbTnT5MDHJadzaSGI5r//bXdl6HxMvVMz+Uw7oGwnBV6xbpcRb89tsyjYp79r24ihaP4Q13YIQKKbQohdBZwxzqDSKuK30bqc4rzXcPn1g/e6OA3o7lOuAyi5tDgoX865Y9JSKR/e0u+QPQE6oj1DP5utfy8q+8khdGfhq7CGwh5kchpmIEhIcaRgK36BBzqDfUhcZ2gm6jTsQ7JhftgWvThjsRc6UD9BxuJw2+sNnGBF/VvJ0xOERlM6IHp7Yzh4WlbGDcgNQ22pDLmBtSyDXM26jCqt4aLlh91jYydVtyXFdv7+y2bhC1UGQLobMaDZM0AkE1OvNGh4gUjEjCVi2Arvhmd69OQ1jJLEoZdE5zbtItk+t5tVwLJzVCuSWEzxpyjbVFCLnAeitXwDHZFhbghOxtVLAAd8NHE9oeQQ5fxhGFs1vsrThfPToDX/1aB/Pdxwi6W5ts0nD7dvRq0wxs5UqGsJGtbdSX+e8oOymudYhYq/cODFu9d2S0ibjM5Q/4BFs2R40GCSPCrg53Q9ciTKM5S4GvkdYgfIfcBTQQ1l1EU1N/RGheLTRJG1crQQzgajE4KfNNtkg3cZI9qGMXoTstx4KkUk5LZQJ7jAqw8Y0IYavnOJ1kgv6RU3SNyXuFu0kDtrq7USNsew811i/gsWGK38HdUoHWR+6uimyF1NpKYSCTr+rCk1IbVng66nZGaCJqQ4qVgjowr4CST62pBSXttM3q5Gf+Vp2Sef+yZjDaRks5WciIw1NkLdQJkmO3GhGeFmsZMUFC7DYjorjZIwAcL3GzOaDoL1Jf7wlAhGmpQEFXTdkgwLwRwWfM2WWaqk98jYpHBCeAFIzSVJ8nqASxPQJY6dq25w2eqL2NUh8lc79zgrPlV1MCRXBq81Y2nj3JufKef9Vi1uXXkEQKJVlwwxfZkuj8Zewb4FurBQjYlKMJlFZXnvEDOYdmGyHLI8Guvy+YEFUO010WrcUjh0QCtSrTqnXqkqWKbgWkBKKhpih+2E5d2OMuBLywx1uaFi4uM/l7Fjz/rPMCgLillskRoCbGYSWjrIfHdy+QfAuFWkvNX9BSL7bx3sNiyC1kzJByPzWwNzg6xKTvXm45WvuK+UvOKdsXulMwtHQ7BZvySk5QN5lgmTrvevfaAj/0QoomjiipDeCOjJv21Mv5a8ht1n5W0KXWA7zv5ChfTcYg2rkUqibjCVhNxRsasajkSLjBeXCKFjcJrs14pXIYUEB1NsQUtOozCKgZpxsNwN6wHo8eHuF7Jhby6ai6oQDWoHGtRrvGfZ8IvUK959VqF4ZdyhU8auQouD8kKdAdLUWWUoTKD20Y5UdZjDciLEvFKUaGD2V1Ggy4rEwjYrxZQPyiUiBZ0PhEFZvZ7svJED68JrUW5Rj7N6ECw/Bx9nehosCUY61FehctWfqCxSsqNQpqYJxBKpDFGSq65tZRWIfVoLEjRsaMQErKB9+/aEbKvUvDidCYT5UOBekXJ/UQBOsmHk7CC2tdmnKj7cTwzutSU/biL3WCJxyYcqRtOBH6A+n41ZAi9QPykaxFjNXA9GMaPMxfAVPG+tu0CO2LXaS2lRepG1fMlD35K1LlpzoojKL4088L3+sYHMp9TshhcS4i4Ji4EWxhB8R1CD1Hw+FxogxXxCNVxYi1qalw6fc1OMMr9chaUd7r/G8U1KKSouSFTwJTjP/1mUBA0kaFgtI8dZ09gSiF/gzTKiSUTCUR3jKxSRFmKKHVcq1GOU/d8bxgcRWnu2ULngOjCkIrVqG6vFYkoS9ynj0grmKEFpxkLXO3mcs3BzZGiFqDkBAj1FSC0saZLF5R1x3ds9U6hZ2H4PKLuu6osKQp7LnHOqlDqtAc1tEhVtlRX3KEw5gUshLjuf9QJjxm2MnCDjHNmcLb+B8jAY+pShHKSKpihDtTFSSlH1XqX4HPdZQiyEc7thnLiF80T1lVBAH0RkrRpBGtCiHIfJPy6+DAlHRY3n8pRe/9r3jhTUrrka444Vv6CpVyXy+/AwWUmBF0jrwD2n+CPBJtyFnxDSHklPjtVFW1qFw63oMW440U4Zq8+ZL7x0QAj3RuxAophnmss8ssyg56+RQlqZpiAMiiOrHX0iIgbtLsviz1J0EH+VRafJlxmlkgEddp8pDI9vjA8ytd2ab8Mfcco1IuEawUX/J8UYsXnLZmLhEfeBozwLI2EctKgYDulySO1Vlk6vaEApQdlIhHrbWwtSiIixVgiSApi9AT9IfIblbR7jdB2GhJKUDBZu3YwvksERJG0xvBLiVNqqUoZzHxNzl+mwchqL9LFVGpUFAKyPJP8gmalV9iNlD3+aZ4BA07erVfVDIknJts8fguUnPSMgHUfyhWJTWP1AxkpAh4v6yBjrZE8DWZfy0Rt5yD3pjcPE9AZrYi0LWS2YZQrZJAt0E1mCT3QI3mDrsBqoce9+6nbTYAb31q+Ke672mbMTlb8SeG4CIyQqQOIvMVQPeQESFzDhl5uMfF6FA6XULu+Gr4MG/3GqLE2PkpHdpNnvqGKgcBxpk3KviU2iuuw6DwJbYR04FQykV2wyxQoQUxNUaRviAu0sc4OK3n3DQ8QpRCK0FeaCXAJUuCsGRJYCQhCtokRJVvA49cKhXK0KXSN3k6gO2VElnXIuiMBX94SDHWdUaIdAwyXwF8dYwI2dtj5OEvkNGhfIfM5aXhhPXzRGSBd7S2AYG3s7Y4nXtZjetkV0Dz1M/hnmULB+luVgsJ43bWsl2sVoPfeWoj4t56up0WcDukjUxwt9Awd+jVQm1w7JuFtpMD7jW0wQluNhziDrvb0IXGvd1wO3EWcM6HTQs54mM7GexWL5uR5l6vUfQYrx/R3V7b+Z9C6jhsalD5RocN4zYvZ/ogvc9rCD/4piR3nED2xQ9Rs+DbCmxsBr6vYIgTemOBTYt1Z8EQM+zWApsY596CLi/SPQA26hQ3AQwYEu7ScgyZ4DaA7YZAzlp3x0X4aevbSSHnQdukFCdCD5EHVTe70KD65lF8YRXOHkpPjfN0HRpcoNIyiKZEZbsN0FTl1kTUn6xMZkFI+rKzRmknMJORgpIcbGSSNIcd2MMSHXotwE112G4HMNnBWcVMlO6w3aCQsLdtBWbgezspyF3qbDYxHKbdraXtMg0NfFfP/VBuUwcKw3Fatw6q69TFxHWeDhEvwma/TstCQrEjGT+y7GH3E8a9pGklRcILcEm7tASOsTHsHyNRXMch6eVdfPmc1IFkmY8hDvXkdXmxHXlD9ABnugtP4E4fZg9zqLfBcV3qQ9SrZHcfjktcKpD0ZpXOBJ1BzIEWVIRVUhuUstKhIy1CLtlxIUE36wzyvayheEaBhA4W4nE5aYI8Iy3Ams5KI+hnNGB4yks9wbyGEQZqLYVJA0HDJgSHgtozHLLHYpg8PBzkosMDQsOs0JCQS4wVFBrmhoWFXGqcwJCPGSk05OJOERwaNCY8PNQyZoIA0ZAxkBBRe8yEB4mGaPU1pSieInPjKbROYogXEtZycSkCW8P0wKsu2yYgXXe5I3fQlZdb0bEX51sulETkRp2R+onDrsDcxg27BnMEPcpoDr/ubAQpoI6lQ4tQy7IbcdjFQdu4YZcHjaAPqeHuAENKuEcwhqQfdBghCQgjGcNSELyksIPWR/DCsgw6zDR5BkN2QDMNOvsblIPRhqhDsgta217E/IJBWvCBXu0tO9ahXkPkoNyIll+aIjtiJ/6w/IgtVuBmSAzZAsyRaG3pJ8qSGDIqJE/CtQQzU2KQFmkZCC9lHiIFZXW0fLQYeR0+r7KV2RGzZbRJd23V8qkfKavDRkLI6ajapccXH6WpWnzeyW4ZcLKlwyql9GEFsmcCzrUc4q3qe2+ymH0H4VZKSalESbvrBttPGrq1HqCch13i4DAC720YINRF8qaS/Z6bOydAb5WSM2QFn1dyBNysiNbJPZcCoMbVMkUlQ8CZ8ijeeXXmINYKBHR6VIHAVQIEbM3Rc8F0sNPrunzOLB7FcYBzwR1+4hjgWhjgi9kif1kXdZLQZ+hvXQrWS0/c395lT/LiBWv21GIk86fDvJT/U/CttQ6wUiKYmbbQ/iMpHr/mbJmA5n2X+1lqritNAguU07peYkGwla+6XmDRsYaeYNZhhR5htgvrl/z+Md95k9KPzPPiMXynsgs56A1ECbuMog06m8fDCjqaZwdStA5h5Kj7w7uUz4GscyNBxAdecStC3HW2n1G5K/S5XJdZuV9AoVauC71piLJy30BsB04HNvDUvde4FIGorBIhYqw3YlDOeis2ASt0dqDYNyKELtuYdLuLkg/nbVKY1O8SePtTctL93kFnjrUReSVCw3jLFqy8sVxNCP+5YTl0fMq1pG5aNRn8s5Sk4g9KPesyg9LOxnPivF8VLvU7Vt+/jNc3SsEJesbulxF0aMPvIxjgy8utaTBdjrq3taNDd+toweK/h5w4aT/6I8WJOlwIwSKnmfo8imnKn81HlEOGb4qgaHIXXwubUOGzEfZElnFtScRlmqp0IbVfuM+ThweW43SSg0RIe1RkWe0ZCiMNOrF0jD1i8cjiTcqQbKjkyLkL1KafqrXNF3zmzzfLz3J5IES081TShTeiGX9OlpklimiDPS7eR+Kbzkf4vuvAbT35I42KbSyEQdFuo/4a7V1LwTqgpQYRoVq56iQmuU75RY5IKcvL8W7nuF+HXGnHpfaj0S4sbTyLWgl8qtxSsK85f5ALB3HFNzt7ezqmVKLrUnRRihLZkLO1XO1e5zm8nxspVkoR8RbyI3ebxYKx3cPFHWIlJiwxIma55L2RQ4C6bB1KLKWSRgqR9+S0xrWiGmsrPKAllnI8H4J2n8cZmt1TEbJFuonZlffQEgjmQamMcYZJqxWHmtrOcAswQT5O0NBNbMcqiQLQHTSCwUVRbpONOyUIguw5LAgZtn1AEIQWlpG5Cy78tWtDI71uW9C9B9lAyHvr/rHBda42Uo82YrR9ulvXDyH2l/ejI3fPCYJB+48LQsZ2DtuB8ALO3BkFyp8zliN1Ya1F24PXXCROnAHCa4mRAed2MSoEFlCDOgrUPTQIQgopTx6F2ndODAR623ExNPh3pRMt/sDz6zwSm5zdJfZmBMGcylEXq7MRzHeIJHyX0mdea/FskmNC18710zRL57JKIKzXuGxWqQCgwzSt1TsFltfeO+V9AGx9sbwlSAWeRYGTYIsXcDTMKEyO1R9AB9CNQQVNfy1Y+Ow3iOsc9AZABRz3NgYTYz5pEaNNJ4Pw7p04AGTI3Tg9oPa8YPLXgiaF+lGCGcGkwoW8/i5VWegUfqpM3Tz4e7cWKXTfNgL1+vs6ymIUVtZIkcCGjv4tUNjZo2MgvwaP/R5U4OA/CGx0PuO0rRGjbeG1Wz8SjAopGRmEBE9ULVqcWcqHbY/8VynP2C0Ta56JgJnKefyHmgG6ZNBZwG2qPt+SCv4/oLTkQaNFhqvHrijEKe3h1WNXFOyPHgWsY48iIMTm4W20MHGdt8u46cOCgtbDBG/WkucLdVCE+o74lqlSYDjigVZdlqp5pRrUvFbTbTPBOTcKCA44OMqPS9EX/jrbg95QQu5jf3DQ96NHHO5Djzh8rR7xYWPSRRHxNyZL9Ifvyod715WPqLoyvDGPJmzMJ5aHN2b1MIWPflNw8w0iaLfbpjtQggtbMLBJ6wbzN+l7ufPL9Kb6y/x3tgjIHGkrkCRpqWaQa8o0CvMleBkPStm8kQ1p404LbssJWPEgX1gPv8oKqBQp0dNoztL7ILe4n1wLAvzjY8FXm7RI1mmysEt6gewtTUr8bLOas/xrzhZJ2Kjit8DIri1ZSiOqPnqZJlHAsO03oRKNSlFkA+wRsilgDgoDOI8TjI3NoVwhzqAunXU8V7BDyG0y/NCAhxoaHhiFHBYa9tACYsOjQPXP59yfAKHVap07FJCRey6wgnBvuceKBj7cxd1PD3Rz9+HbI9y/M31RRdiy2nr4h03PbzNi5ubbjedvXhVPuszi1rEzo+Gdx8kiCRhcB6BDcdxm2uKWR0EFnNLRB9r+zb9GebQKeKOaZ3+ouFELCxo0sloIu5ahTQorZBgG9d0gHAwLn7GGgZOHjOfsA8/nSRyzzBwtBe+pB0Z3Wemua10iMwAZGx10aMrGGFxAUUCXF1oRMAwcVg7QJgXUAgwjhubBtCFBaRrjMMMzYXywwFSYYWRYLkwbGSEZZgRyYDZMBxaSDjOMWUT5A0OY1modIky2Wqf6RAicLlDpEXeCwIqQDi2gHGQEZJAvtcMY7kAdRoTux9uwKJtxL3Z33V083sq9XR5MXT1PsaEVl7lcNT+FN6kDpw7mafTCm7RusV7sX/SSDgv6sVKjRL7JfuGJuv77bjO/z1nwG9eGT7JHoys288Lo0pkRnojmgwdmovUid95B+3q93YjlkxT73sAqfgcJVsBftwvZNrLmRBppB2DD3Z1dWqCbcwgXEGxwWaFxhmFQ6CbRQkXZIm6BBWwQa0ro9nALHmhzWAPC16tbECGr1ZoQvFbdBhi+Um34gOvULXgoq9QaFG+NOoyMNXjihIk80O0pPSj6XT74g03oOAfyVI1C4b5GOoRnABG84nAOr4G/NmTH7XRYEV4XkiN2XFDY4ToDkMAlEVrmxSAmcEGEeIjOAGr4cgjj4JwBOMhiCKdedAAQsBRCOcRlCC94IYRxIMAAHMYyCDdtZhww0oiOtwbqT5IxN0UELYLqR0n8iXcv2SKkBV0qOTqKSiik8ZrmQc2da0EC8uYGAcFdssWK0ykHsQNP0mjBQo7R8CHab06Vti8ek/XuoPbTBO+PvgcrNMTVYTN38YJmSae1SGKzXWqE6GwPttsPzMUiQWOo9fAPtJlsU8E2lHYD0RyY2uHFyIAcgQ3aaHag4auTkcgfI1FcxwketUSVYgkpOGjD1KGGb5pGIIdtnDqsgM3TCMjQDVQHEzjODoJWFzihwFZilMCBO78OK2T3NwYzaAfYpQzfBY6AhO4EO7gou8Hx4KhDbsk+xagL3j30wQP3D350e1l2Fz0l2UNY8UfzLMGiTHxL1r9GaRIHFv224A6U3pOtF9KeVmv1NCdTCTmhuf/20xTeAp2gXWbFfA6qpegQllnfZUoMoK7Cabnt9UBVDpUyAaOVq4KgKpcq4+GXjvaYYfcRdW/Ke/uSpdHk1ZMUO2Ees5uVvnYnvhRX8i8g3oFSTErFSCyMYkiT1u3Vu+JZp5Lu71nMcvk9ORPqLj99YVhA73CNKLU3jba6zk9U2hTmiGhZ/hJQeKWUVEokqI95kn27WUUP8JY2WkmlRYGrbipq+vi9fU9cILRSbPp4efMcEvrh24uz2Ulzj1x9Xq1zFINaTw4xO0/ijB1tOHMxX74TVvkMEpB9nPs6GfnDyk/u+vV9neu339Z58hSNnlSrrz6wHxzdBsrEvrNovid87NtYQ1QPYQAsHhnLk7EJoDVC8xgKxCavvKQ7g5hHd13LbIGJo5ffd/5JqocwAFL+8Mmcmrkzhnx01TyKBGPf5hlCpCfgeFM/j4HF8+Qhya6zYvxpMTWSeZZVz2LgiH+mu1KYR1C+vIjyoHdHP4j45nxfpYe7vzr1U4EIzp2Lc/npzfrz6LBFTWEezHa7/X0LiHHCqFVC0KhmXDjyadjP40H6zJ7DiTL2jA8UToON8qW8CPpjtMnkDJeHYfHyAui0UcFDVAvh8BZTi17EVmOZuvBHBzfF5VxIiQ85X301YjsCGi3tcBeR1lpKrXWlhY37Ve4OpcZNBqddG6kkw4UVi2jNfjHr3d3Y9JO7LtS3oXxXm6Y7U0F1z/8rWX9IRkcBGiytUtZhFfyPZL1MdosBbEF8YMXlen2TLXdeyT6oQ7TWiXkSC6W+xiqExn4YD8hsKsN46meRcHY6X8dm2f3Umu0g76OXkMFUPikX/IgDqRRsTn8KoGkOgqMA2nlJ5xBhLe2s67Q/j09Qs5mqK7R3TU3bDvWJZ8VjYC9aqWdx+1EgCT6Edux+VKeHBuJo721aCiCCQbkIsExeXgAPX+8aIBsDEvLC8/pJJJT/3MjdKcsD+/M/zdO43bqK0Abw5M2jWDCcF1dRKp+JQhsplxKLUgK3pe55HDy1Fhx9cv0HY98+JLkATPjPUmKpJEjgAFC4MP+HBfemF4bai1L+EOBsRPpyuc6M+epOrnyznSnMs6J6FgVnk33JqossdubZZDxbNg9jAW0KkcTsy1JVNYQwmef5UpjnMbCEDuh/4EFd2Dy85Jid2AHaeVp1iLCmVmFWQfc8zPMhzCJIzveY3g7BjQt79ybixoWN1ToFf3hIjY8o0DVkFLRrCNcjVMiBRUQLtcyKdl67th/GANpk4U6q6lmYm+qoCWpHVhz5KcoTdfW0FyEChZGbL6yGY/tzFcCKq0vRxb9Wn7G/v/vdPnUrbj5G1IrUb7XNB918ffPTfpD75BflqLtKk8W3DzyNWf7JzjNi2WY1iNKnsjNjT05Uk0WgerYTz4fzHViaIaC96tst+E2uHn4zB5xSGOPKT2lXPE8X6oHy2wWJdZ4vmcBG/J+L/BfyvOp3LGWLAvCWNwL4L7i+ygWH66DSgrWt1Vw9xIX8mt8eEyuOCOW2FWnphdy8pEgd4aAWo2A+bLpyzJaR/G1r6vLrhrjLx5A67cmsmcUXPJP7wM2i4DkE6sDVCWrFqm36MuJaNVMhlL95yqUKEf81EX9NskeWl2UdWMTr9inNQcze05npqP/ynMT2kcIhzLXEFMAq/CdAuJVCh7YuV/wXOnxd5Z0zWCexRKZo8gVfrblKUAO+j7XOZO+kvqQrSpM/GIzc1ZmCfO3u9UOgPZt9VN7D08PZsUWMMfzRj34tahGpn1b+rlfq65xAbgh/Lacf7gR2cS1xsrGiNP3EikcOfEWlzKqSmYY7e8fuHvkzcESMsjkTpcwk3GoIhg/iU9Gq74DRlgrT0LIo26yBvJXGJMQ8TaO1SOYpbPhwdaYhVw8Xd+ApshQStHOkyw7t09P1aCHepXzxDYo7L0WmYI75LVOViyDmmOeVyBTMyyRN7QhpCHKjMQWx3DhdpVx+S/G5+A5cX0uthdHKiu+Ua+y2BZ37iQLpJ1j92eSPURan7PoJutA2OuyJdrXdQ36TXWFsKS0bkox+f+lYkwA3Z1P19ERcZyqMB8QVrFaZhtrcv3L9HdbLq5tX2nXK9OQ3wPezIk8mez8T8WsCXw0m4imZci2Y8gcz5cvp7zrPgT5iqZZXaqxUm8IKvi6uwJszKTLl/kwxAxeziniy9WzOVvwJ1rlriWl4wSvZSdexQq6p4A5AqULuA+zmKkHnGaMy3Sxjvg86xxiV6WaYIk8e5LB6xVcrO9QfhG6kFrXUhPzwxXcpRLz6xovq/nX2Q8Z1S6wfPrJbce5XbLem3qvobkW9N/HdCnifI7z1i7hvMd5mBNm/KG/FPn2cVw1jV0ogeNVUsSulRa30w8eoK+yJo9SPzQGW4J5unVtJ6oNyLcjsUpLwrjIpL7ipX6GNnZtzw6k7V+aScgNiCDU0cewANWukHkX2Nm+ksuDVMkd0rno1B109RtkDeBo1kuVktKglX8sayCZzm0lTRnzmbMnNWUGlbbfaf4ZhmpG2lg/GNde1jsKau+dENieuGUJr0vP/PUt5hNK7jN5G61Fyg7PE6kX+3uWJNeSTZ4qxxbcPmzT9hSUPj9CeotWWUu2xUiPpJ4AAirOBnaqNAfltNe/eZLg1xPuV49Z4CPYwy81ykO5PnlsNvS+ZbhbwlLlui01xkxXcLK8gEZWaf1PIf+NmUdWNq+CRA7P0Kl5vnh4epfIGFgkTt0yvcFDWTJVmXmpSrpvYdyZ/UXaTXeptgOon71kRJek/tGscxRzzFUlmdhqq58T6K4z3fQLr1Dlk6pB/dJvUAWXqTP8pLFFnel6Kr/ESh1/JRWIdLympYVmrFey0eatLvtiIL5l5CzDaWgvyzPR50tbO+SLCHIi0YP8o9KPnDldm7Gv2sMU/cf6wOleuHi/h9M0QSdTz1dluWt+5BCaY17BuvZPwtfOz60jNXmdoe6yYPEfbipshelWtCFqvTxXPhuA88zo8PF3OdrPQxIkOJ6JZV5JHiVGz5hsLfHnzmJzQPPmGdP8y5dvs02UyJuIzPKKdCOKYdpcY6718jTcSVp3QsO9nfULF/1oVClkd9wIPila4a6q5yaa/zOLL8qgzlPWAbY5c7FTHqE26q7Ltw7ZpajvUQv9TssJcsunDVqXsSsq+QhwcWN1TWbFP9T0282R+/LUcFItmEYrRc7RkswqlXOnnLIq/ZOnLPVP3q0Z5kr68V9c4pTjvgJLnUr5o5ONSntaqZc4ENCmtUSFkVL5khGVdqaYcyBOu70DVbQ36vtS3NcSdCBA1Me4AYzQnGmE2mb1Fx4gZSkl7j04ZNRSRHcT6zJ9xLFCyTeAq48/EVixynqb3/DpDGdWNXMFVLyLsOeV59+X2EQXcHIFfbiKnXI1B61QtC/aqUrXi3rdaVZd7Oh8PSrVqDb+n9aot/v2pWD38MStWDyerWIUWKRzuZfXn4StUf0KLJ6s+sXfFk3Vn3sPiycO9PCS3wt6vY3Jr6v0teDrc96Ny65d18iIIiOfTHhon4kVI4Dj8UyRwdK2YPIEDvFU7fKWtGsrW4XDPtw6He7p1OPoxtw5HhFsHtxw1Tfnz39dxZNKr+aasSQWCa9mNln02sotKliY15jJN76InHfC9N33QGAW0IxHSEuU1VNHesnNvKmGa8IQcvwz6fbIKd5kfVR5nKWeAi1KOxtH5yNRdeyhtXomRtnOB2Emm6BdG/DN/vll+ZgsmRJS/ALGNZMafk2VmSWI5KPDG6OMfc4w+nsq9M0/5PHzjXmIqkdaeHdO/oB4G/sAHjQoh40eWPYSfm+KSppUWBa96OT/xOFkm4Y6PEldJrRopClo5wb/HA5ZqNMztcoO/CZ5doXReKfa7FEPvw1uI76IlS4NnAS+3qCR/vFng5MecBU725FjKk708lrKi3q/AxMm+HUt58ic4lvLEch/uVWSlHkH2MLJyssfHUp7s57GUJ9NEhRxiwYoiyR6g44sl0z/E4FEXnKdFEnyIzUmVilKpEDFTHAB6sq8HgFov5aS84KbeswNALer9OQC0gt6rA0Cr8Xp/4+HV6P1nOAC0Wun+iQ4A3WLSlPFoeNZCtRDev6Mba/I9uuTX2TBNxau+A8pbakzDCzoGsSbes2MQ6x3pPh6D2DjktENzP45BrKD35hjEBniPrvytqIkPEwQel3byKseloR06VuHv+aFjJ3t+6FjD/wqHjiUFePJRJ3eVMhTvKELmZ+Vj2e/Mz64V01+vvAB381KCJLcM7Byf7FAu44U3U+QVX61TBqxbdt37ZtJclMKkB6HhHS9WmbC/x4vVFvzwx4vVpHt4vFiLPZlsNIcdL1Zj79vxYg74nh0vVrPv6fFiJ/t/vJgVv/gzHC/mMWfvjxfz2LTPx4tZ5rzm8WJZOe5+YtkGaEqZ9fe9WBktilUF9Di0CnWfjkOzmCfz5wGP3jrpP3qLnPkGvv0rlQh3gUjHhrm8e3VsWI2+N8eG1cQdXy9pFSvW4UlN0tS+Hp7UWDBtRS6C+5HS96i1v6bRgq3gjavF1pYYCTH0OKo6l27PjqNyuKfzCeDUlFfw+1pT7vLvT0356Y9ZqXK6J5Uqp3tZqVJR71elyum+Vaqc/gkqVaoXce8qVeoRZA8rVU73uFLldD8rVU5fo1JlLVfCMexYh5LbSKGf6kBQ7XG6r9UeVseelBfc1HtW7WFR70+1RwW9V9Ue1Zi3v9Ue1ej3Z6j2qFaLf6Jqjy0m7Ve1R7WY3L9qj5p8n6o97E3HVLzqO6C8pcY0vKBqj5p4z6o96l3dPlZ7NE6tYn+qPSrovan2aIAnrfaIikgf6gjEVjqi1KGIjqiqFFD0veLktFdfQatnLMxORBWPElg9c/oq1TN8sYGOBpUGSZuiVfdUsHte3XP6ytU97+WQBGePjQpFj0GoQGo4J65AQqjtqTxq+13b07Wip7YHjz+8WqZy0E9WLVPWmEB5y8ISqvbEq4RpAe9hJUxtga8Shr66BJD/UpPvYWVMi326LBhYZUyNvW+VMQ74nlXG1Ox7Whlzuv+VMVas589QGeMxZ+8rYzw27XNljGXOa1bGACtNTvew0sRinrDShObq+tMqW38fr66v4ffg6nqXda9qUGr0valBqYk7HlPCuo3m2nEgtmhuHCfq04j1MhXz/tbLNBZMWy8Dre443dPqDod7un0tTnVHBb+v1R0u/8QxBLX8hfu1C6OCNC4iVqCc/ZgVKGd7UoFytpcVKBX1flWgnO1bBcrZn6ACpXoR964CpR5B9rAC5WyPK1DO9rMC5WxPK1DOBipQKDPJUSpSzva1IsXq6JPygpt6zypSLOr9qUipoPeqIqUaA/e3IqUaDf8MFSnV6vFPVJGyxaQpd/VRHN+sovCb6ysz4jgpZSj8nYoyW6SbmEFc+BarEevMV1TE9/xedRuY68qLX3DdcTx+LFRbPiZZcBp8w50aFULGe34dJ3BfS8lacFapkTKjdg4DPkmvUNz33KTamXZHGRLjWNEX3IyN5iegjGLWlmD1HYNP2nfglYSVU2D/Kglr8n2qJLSdR1Pxqu+A8pYa0/CCKglr4m4lISIjvHKw9sbtY+VgE4wopq4czFlUMJQh2kjRjs/6K9Ta7wPPb9mSSdUFQ1hGGWG19FvyPK+ECVdWgIrNCnlvKjYb4L2q2DzbVrFJe68YKP+r4v7BKzgtzE4+Eh6lissUCRMoBYclcqX5GjWH7DtbbAqm8u7U6hpvf1AKqxQ8natEvj8A1tae7V1tbUVMWVsrVz/8Wc2Hf1fv1NUmFxya21NjK2k1I26U9EJL0+6Fl2iVwpUNe14pfLbHlcINO22lMMpSVuqQrmMRKpob0unvVLxjqc4quYdH8aWaKNU6kXw8ZoQq7CqKvN9V2F0rJr9h8TESpv/AO/+jeqiRoug54TXkVYrNZJXBWYIz+Ckh0tEvyQTL1WTC7pMVahTHKKsUlUIqT+Gvh1buV+C+yn368wYQKoRbBuxhJX9twd5V8tfke1jJ32JP9qSSv8bet0p+B3zPKvlr9qkr+aMq3SBG6DNKrswxiCfsPeprHVc56EZ0yxbHTd69o2gPTliojdnfExas3MU/wwkLHnP2/oQFj037fMKCZc6r3j36UX7nJnpgOEmQPEtLPV8GJCL3Wq6aVE6f3MtvciV5H82h7FJT5wnK2cVoFlpzkt+hsecze0a1JWPPU9oBO7Gjxt+jEzss5sliyVJGMCmxwsiP1WJLKdbNkt2/M0fOAs4c+WHv8K2NeYU7fK94zHS+wpe1cgxCX49SdSFVdfoCr1UntAlxG1LdTzz9TsRjC84b0zFogtN5oCffuPCTn3zTVH6CDXCkaFocck5Pzbk35/TUxJ28mB/6nJ6qNGqfzumpmPf3nJ7GgknP6ZHft1nrNdwXtWIH5/FoPb2M47XeJHY88mcoupGg6Ong05DO9vQ0JId7utgAzmlIFfy+nobk8u/RaUhNTskPexrS+Y95GtI54WlI7aqwy6KIFo8rqXYbPvae12VhUS2Xk43DhjpP5pvwBb9DXEsR0b7Lo2wRvHtvUOeVDhEnZAfVUNJWHNdrzfAR1UVd1GKExLeM5yakhQOd23pE3MZhA+fla8KMMKl/y1QgGoM0b5SI8kyd0TbYF3Zez6zOcEuVx264zSCJhm3kaKnNuIuDbMZeWt5rVcryAp+HVcK0lqKbgx/Mrv8mRmhac0ARYbu6IzASce4IEpGbMVgdkYNAbQbirBSjyewWzUjBUpUkYALCUHop3IwZRnhRCxNZUs0rH3iOsDCSgtX0suQ54RopEderdfECxE0EK1UIGWXL3ucM2rIlqmzVwojREFsLz6oKCgxurT/zRpOOHxWcnNgMfmjMZvjDp7b9ER+aBd6uvNajP5ZXog2G4Zew26n/KN7yE7uX6HWQG7Ek+JcfwVy+yx9Z9rD7AYi+dlZqaaVGRZ2Ir9XJxGDmRKwtLSpileYGRi1FqBj5c8ZyhK6rdUh7bc53z0DuYJYiVIxFSJp0B7KbF41LuSkWqpDqE4+TZYLwNkk9VT61avSIye9UPuwmZbFcml3nkdjk7C7JFvCWLy0Rlb5crTGjL0p9RMs6foCU75wJ2bFA+QCMDiFpyEbDRwrZX4wg3QSdYd3tFN3zq+G9urUaCwsTNE/+eGsxiwtrKVY2Uv9KzHwgbDazeWsp2IS2nTcRNyYYGgVUObWJ5Y7dESNizgJOQW6jdg4+xiUMOou8w9g9jByVMvRM7Dan9xgHVNIiILTepoQE1ocJn6J0A0asRPAYW6eJxwWHMhoJMsJEXG4KHnIuXncwiqQS5CC8MbxFlNfufXAP1VoEb32bmd8VIeHVDi8XBSSs6mdtn9zDljpNFz5MqQN8bDE65tCVaYsWujAd5LyvOy8CbdN76ZgTgdcdEjFFb7CJP8DXsDb0Enkdi7RrsXHhm5burGvvWcKShcrHfrDdigWFslUp26ZnvWJC9AFzlo1pRACT1XbGZc5XdyzKF0HlKg6pkhJaCjRAbedNxPX3dZQFxF8c1kSwRoaCM3B3YjMCFynDfKGHzHUowZuT7axGJnD9Z7MaIdJ2Xedy7vgOo6wkkPg6tzT9vvsGxeEzAjR0wetmmxC8aO5SYqw+bUToMm4UoRRZXUWLRxRUNbwvSjEi5q/1iw4Fbt50ItpE3PP1R/bEUuA8VPB1WspQcAauMW1G4AKzO17aq8ugH1s99IOtLGsklHWlbpXBPISdk9gsSleFhNJsK4CQjQg+owqfBawoGj4lAFhJbGMLvTfZ7oi+k1tR+e554OawBVlwWCXJVtLH5OExlf9RJxLzb2z3Ex8sWkurqLTwiSH5Lw0rRubLNsqgnJcGD5Ttso0rcOfVkAH3B9vYjAikBzYKVHQIL7URIn2rjaPhlolNWoiPQQmZFrBRy40aLB9zK7Xx3+pM9JCzZyxio5RbSgS0QTlOFiMou2krWUis0gKDhClbXAjRvwYMEvjbzpWIS9nDk4ALj5wpJWpEcCjtvcpvv8kubaVKXGKsIbWolTKBv6Zs2fAUpYnaMKlS9c8hWRQ2eyWmeiwonWIbcxTHQafb2Sv1OO6ebIfIF3YKigvoOQEFi7C8Hsk8CaAsdUSlg0+qaifTVH3ia1Q8Ql4sVTaZptr9WyrR0NYb1XcvoGWdU506f8Fb4fUTQ5sXf4++hfXdy21I3nUf8fwFlIE9zB2YSNnmhZ21MJoT3hUoZy2b9NegLCs/LSzZaoD4nbowqxzIYLxzdVlWOZBNQRsY4uhlBkY7hshDstVdVkie+hCd3mNC3695o0JIGVCd7sME1KYPcep1IE6T6vUgdbtq3sDCfw8usPJ/NC0WKx0pT3l+pZSBpEpnUeoQkaqnIYtujVmJ0DAKgdGWQpC25IcklR9lMeIYsCwlJxkLbhYBqSwObrIA5LAM0P1N8Aylr/4uhYj768doHhDXdijTUoKOD9g100qDjhBhJa0pSVfRn+RyPQ64udXlXDUqJJTqn6/4ap2yoKMMHFY1cS5sLTJicc9Ld2azD1Q5OXB+UfDKp1krL40yiTVfnjMWfsihy68KyOGnHO5GDBwsXGSyUcNlRhg+XG7ScUSzI0wcGpl09mhIMXoF7TzSsGL1BvoZRTNXMU4E4ryRoufF6BLoUdmtxFgdo6Im7RsmjoOzuTBM1LsKmxjsZLCRCf0MTR4tEjGxX6ThRaOlY5WrLPmJuCk5w1pkrEvlpvqMfsWBM0xTj9BIgzP5uFxxmppPHNii0pqAGKl9i1qMlBlh4ptkzjNPXWdPMFaTFMC0DA0nzwtz75aKUd3KPXIOnT2ElqzCVHktScJ/j5ZcV1dak48YLvMd3+QLhjAPtui1LOms+A+efxPraMGUExbB1/1c6SmXLKnXuya/j+bvosW3h5xvsljHP5BMKKL5vBZelML4tqizjrOF8gxBwNXBxo0KDSWCG8k+f5mK8wpegiFVsKsw2pRQl4uUoPO2SHE0z6HUmsBzWBEjNCuxJ6siRVjCV7Ck63h9gjkGKillklUpt3WfDaugbZAbybrrwupot/KLMsh4+RQladCBcxa5KAONkSVGwXydJg+JlP/Ac4n/xHJ1LP09BxxebRvBSvUlzxe1esEjW53Cqg88Dbjn00FfVhIUfL8kccwyE1YrWLrzEf0O6aMWW9hiJMym6hfAGV42PMR2k5kWvdvMi4BrBBzMJDMNKmotCuK/yRfbPAiC/V3KiEqGhFOAJg1JKKjmC7MAu883xSPsBdIrhaLSoSHdZIvHd5EaY5cJJP9U0SqteaRGVKNFQRx4R7tD6ruRHY/wlnPYu5MbAQq2u0epA6v3EpUEPp/yDSFssZQM6R5LfcFXcN2uUkGu3W3dqQtOKgefmrONL/AckoYOeApJi80+g8TkFmUF2/0iZevRH+s8kjYYxqkkdjv11OX+FnrccYf3N++ZYoC7hUfQ/+U5iQPiNh32WmYq8NDDQrq9xDeQErPLHQPPWMitOp5OXmq1ivtoLXjkiSgDJwg2lGom4k74quoQc5Qmf+y+Qugwu1pTtfsqSrLPxXeENldKWfGdtL0znO5B3i8yHlZR5yWFFNSNYUX59al/+bruHIbpKV+nfb/WVhYREj15731K2PPdgu9+OkgHWCmJUgmRtnUsh2oQlDeNnFKNCZd5Hu3s5OgdGKJSjY4bbTU6zWK0RS8iNa3KOVXH00OOEunYUUtqgc6BIvgW2VvARZSmn1jxyBEWelJqVUlNxh9yRop/iT0htVoNFwkT1bWl108Yk1GlWt1eyp4AYZQRVuhCz5hdxwnGZlhXfMaMVWqk1EqjuA4rXPKTa0UGK18aR/9JLoyRXCO6SkzKLWo5Qu7P0VPyYBIbQ84w87FntSToWLNx/F/57/yuCHCY+cjVed2iADjPxjHfMsHTpyaBEAM9LzVp9hKdBMjNvPzQzp5eH7zYzBeNHCH3vfxnvJFR/THFyKjOR/sHjsNNUUs1j98Nl/oxyuKU4cygRqs7b9KuBiwLbrLQ6Ms2W5JsGh9iO7VIfepjIjB+F32ZfGq0qHpSIi4XRfIEH98TEVVCdKzXq3UB3/clgpU6dKSYC5ZETLNeSeTaPIq/ZLsn4HiQcynFs/D0mxG8clJmxa9ojhYtR+VtcQK50RO757dsEVpr5tlOPzE5T2rFjAPS68fQswLnNZRC1O+h/IpfUIMiQu31yeIi29iXn+U2ESFE0rJgmVWyhHZ8xnAuCthFNeNIv+K4yEVVATrh2qNIVoxv4OyNDlU7F3ny8MDyK75ayfUaHNjILWq5yVrcfDHOMrwUm3odvsn0aADGb3TodmoZy6OC4URaKzWKmJs/pefyWaqC95mWyg+b6NNmRM75sRuyL/0HHOTu2PCbZ8LHeTXH2IMQQOpaRBhMGmETPMmpYxFZvtMIc1RJDWQh3zGmEuzYUt+m8y+TGYeQ19UdFOjcM2MsQsn28ox0lIlfI+zCyabq2EWbWDXCrsyaahHtUrJ4jpURdoBzcDomkG00/Na0cgOwcg47ZmFvs0dZA8yC8XavKdlxf4Lp2x4YrvNagBSuG2cDcG/SNQBpezKKnmKROfkakzJ3qWPdJGlMPXY6FxPp0Ev5+avHKHvAnf6NfjlRLmp9ol45ZBnU4TLKPKxEohE2ouSjdZeilKlpo6zK3rG7R/6Mu2uIsjkTpeprWAXMvfNvg17JFvWVqLaUgq9iC4uyzRrXmkryNezhaRqtRRJwbsb2/akt+yp2Ka3iDnuDWuqKSXeormXI79KrvUlCvEv54huyMfNS8xUsivmtlNr9AJRtFsU8rzRfwaJlkqYBNdbbDGokX8OenC8irMTwrmlKHTtBfIRVKus65ULdt4a9L1Tp10a6u0Oc7FfT+cH4W0adKTz1rhE/u7Lr0SJNtNzNLpScy20WkqZfjrA1wXV/v9IbVmVn2oFmTLPKnM0pvODtTM5MneKG+yMJVotOYoM5ZOsa+zcx5221f4sJ+5yx6wZ39KvsSl5r9EsEMA3NYxKtf79LTzIGvMLb/2uCvrNNxFPyivvalD+YTYZcQ1/nOW7+jBTPK3FWir+Cjaqj3D0nxeIRd+BWuqLRnaAH2pZcZrGeZKOCYOthmyYXR1H1RRPuQmxbSe2b2CZVtvUpWTGqoID6DlXMtZLfMX1MgK/NmXSYFknNV/Q2K4twXWTKntfykuVsmTOBGqxuJCfoX+WX/SMpHrGXRaW0HBUep1sf5WzFQVVsHjNKxVfpXdj+ytf0Vorq2lT9APpALaqbVPU/TzhGY9SL+KyZOqPLPb7z4SFlyHtaI/pqO1rz9cj7WSP6artZtBqarmHU5TTjrUMfKoiLbHryP616kNvk4VEOGhlLwypB2s//WDUgXjqM6o9Os+HWffi5kSs+RtsQmobXYwV2LGWsHX+Z83jnImG/DaUSadcJLEfxA+MWoow1IagExW8AbfHJWINCy056xiHkgNRoK8JLTfoGVPQik7G2AMpL/LYQFJaMtSULd6j7belzpE9gS1hZid8M3O3HFgvapSQs3Tl/z29BqYQ9X2CWvvSA9xa9TPILhJS/9L8Kr8OP9VO85m8QUgbTb0WnAGYaO0JSnnqMwExxGm8B7jp8wmU4egmM3yK64pfxtpmF9rtNUQTczrRt7T6vJYlnEfN1QaeDbuMHnQ26jR677Khn/zFUcETUu0hKj8abiOqYGmtnePlRz/YEvfBovCWhJUd9lmAXG422JCT2u2XbOzm/+jIk/lJqYv6gcqI+C1ALiUbbEF5C1Od3QC8eGm+LUgkrG+r1ShfYBUOjrUF7N17hzQgsD+o1ALUwaKwVoSVBfiu8xUCE1O/QPOsVOZGHHaNoyQ+OXK402gZwoVKPOdtLlCaw7AFWrOQ364GmTGkHm0ILlHrtmXIfj1SU1ONrxC9HCrAlvBBp0Cr8EqSx9u1efNQTHJn8jUEoOOoxZaDUaBLbAouO+izylRtNYkdw4VGfJeglR7vaEpCctd0WxMSs8baEZNL2mTFVBAWtyGibIa/2xgcWGvXZglxiNNYOcHGR3x6ysqKxdkEKivrjXd5SoomtARcVDZu3vZxoYnuJbHw1uzCKi/rNGywrmsDK0AIjv1XYpUW7WIHlTMMtJxprQWAhkd8EXwnRdDaEFhNttcVbRjSJTSEFRX2mYJYSjbcAz8OJWz401gKEwqGe1IWBkqFpbAsrHuq1aLq8PZSCIb8d6KVCu9mBtg9FLw8abUcOKQzqMSanKAna0SLE15+iDGhbpq5VAKQWlvFVlcC9qznu0z9W8Y+HDaP0p9Vg2EUzPmp/yQw6c2DFiY/YU2+CjhtajOHtFz7HPD5xeOGFvzP7yy7QuQFFFj7uvhILdO6wIgQfsmcpg0GLlODrJaYaMtCTeX30A6m8KHbgpBx6X0x/wiE+dYi/pHf4o2UFhIt9xH3BYkru8NDwgAU9gWF0W4K3eN5X1LvBQ2eGbR984Fs2D1T0aN2+d6OAQn5yWoNfxvE9v+c8nUf5l3XReDS1zjJaDPO3JZB2B26F8cKZL4FwB7VcUMN22qxvObVARC7FaIFjPNzgF24srHjkebGw7h2GIluCpOCFU3IDpQbV22xBdgaJQo5H800RRF09SzIsVOI3QT3XQTuoxQB9t26oHmD56E0Ws+9wWvnBpFSiQU3EjfFGRfOw7uryJiJx5GigM3tfEswK2YcMI3Kc7uqpE8bEFEWUF0h9VWvR9lYV2YaDlio0iE9RukFgrGTQIO2R/uo/3CXseMrySaRR3t3OFHwNJDooNYIarWqUvib7zOOQ39U8SDEt/tZxmQZRHfwG3a6WbbPNsXvFN4H9reHUQotSiAA0jooIiFhKEMAl4nq1Ll6AfIlgpQoBYuCsbPNBpuTtcDnn0P5XShDA6Znzy3IpGJRRK/FKCQe1XfMC2SfYrFIqsqRoYN0ktGBQkEt1O2QS4o1xX2oasIL/7e7LZyBcwX8X4S6NLqA9Jct/+pSoxOKbTPb7bBHUITsiFFN1zBd4bAdGLaxBu222pUQ9/yWRK6o8aNbpYdeyj7UssRFLvtgEvV499JUeMbYatza5sJIk4OhqEKs06fHvWMpCnblbLBCWLL0RvwZu5bYYANrWjYdPk4wFL7l76JUmbPU9Gh+120zRWfia5RFyd7c1ifHbSeJweOBlE+PRxSLnaXqTFfzXhD0jWmCE5ef4kxGmNoRgzBfTjfnyq76skd8AqcnX07wBAn+0F6SjvbMO1qHv94Hui+ZpipWve05jOJbnlMad2rJpor5GzJZJvnqfRCl/MD05bOHYlaFo1oX5HhbWtD2MB7ZqYDt7WrHXo/VeruYKcxbAI1t8QzYmEbHW15UYtT6FWZ5+pGqVPjEhogcG7kxdLZIeFaXpPLIOXsLiPLCUIa3vadIeU1bmU/iWNMJkhvT0JX2AJ0pPspV+3H7UocTsRU5jIqdvbLUBlMUxbECr76jas08s20DXBz4hkqVCYICtH/CglAxtb18LYsf7t+NDgv+7G+AcDI5nQueEcDojglebWyzAPFpsN3OMu4vFX3JzbNK7XG4DHm/iwCmg18Tqe3huTlGa6+9JYoCrE2KmufKA2kjzctGZ6IzGOYsK9jHJvgHm8LYGSardpuDSsieWF/f8ZhW4ivKSHijthdEueLKCLKQ6zdkX9WVLJiUX+rN4ltSyqZGlNUKdEK1fibBE4x4b9LnT6hUAZBzvbELoBLPdBND8sosJKoe2SIKylPotKGpRWgOCV7R+dNhadiy08r3eLXhQ1l8PuJIUpSQ6vD3ov2dLXRvJsy/z3+XUE2BCW4JiyE/UiCzYLUtDIxheyoNSN290g1q704q97qSvOV/xIsiL1GOBWDeSpPBpNGfpfVhyq59dK0ISXceirzZq9EqTRRKUneanb4mSGpBtVnOWf83ZIhGY/d/ori1dUjOqrnqZJlHI8tJvRKUalarYJjjjZR49XMpldM7XJyEGWI9TLY2vv6/lQv/THQaeXg8zLbgKb1q7zfqSj+Rn1OdQoJVYbMSIgYOywfuAw9PCxwJfZ0ETj5eXhReyjsctWEiouQ+4CL+eYDSyflfwmCs5UuiPLHoKmtW9zGmpRor85QmxZ/An+o5xp5Ke0YhFqUaIzNefovwbU4F9ViV+/39IBvD1SmsnWtukggcXZO1mDo0hE5igl5t3fJMHpRB34bWeqPTIsNfm5IAPPGfJQ6YypYMWfh38UndpdLNSl9qMzxzfhIxPhn/LVKpV8sQ+ySEP1Yi8Ul6VytSm/MqTGN2KJylKboBJ2kPBrqWIYe9Ypo52egrcPvdwC0eV2oQ1C/O69MGXenTYrLhn3wvlcPmbCNvyd9FZoeJByuUCqXjpwbf3ybpMNTCaXz/7AwXwXSZQzL5pmh5EHhx+a1E2QkSgefKQyI+GFmq3cUs50FFDg9A5E2vZKAidwFIiQ5WLNBRQo0ODKfci6vrmMM9wC9VoQXzCw7g5wwA1KjSIrVNRgyFhZ6L6MJ0x/rtc9KmjySGpW12RHynDu4cON9/G0479AwJPg1w1fYY0imFdZBu63Vc+RNniJfDNq5+l6Bl/UQfgR0kW5E5yyQ5sqaDmbFqpjzZOnuCcRoSGUFefBh5D0sLUUpCV1iBs+EqrhQpcaQ2CqmMdcBpVKZG2afDc1QKFzV0+TKeYqro36j9YyJa2xVqJfWPBO9lh4PU6ffkaFYuQ5KQ2r9Jal1o0uOZep1u2RGlgo5azJWUL67L/K86/JUFepTayUlvUaoTIH5I0LE7mI15WYkTAgQXfnZkWUOM9CBmz+SYkEt2eZksZGkhz8+rf13EUdMhNi9WobSo1ImQdzbwMcn62ebVUFO78HIQ1L4LJZscYD4zevNGjxA4NUniZQdGJEcBIXUIJ0XaILP7MviOtw5Saum0Yey3WOh8kU+czsA88X12nbCVVEXpFpbqUqqxRpTKhqAouMJpdnedVVlaQtnvxIclF8MFeXeilkgMd8DUKGm/zppgp9m9tZEX77gVlkfnA9Ns4f6FcZJbI4t2LXBujMYv5S67lyKC/slwkIjSk06VeGz3IYZRjsG/RNs5SjGLv7D+UisVIM3h9HhWLaafxx0h8CDzIrIUslUBHmA2iJtmSwzFLFSJEcR0nRZIh7EISwWopGtiUR7EcgAPrplq4SkyOv5ByqUHgnFUOGwR/mq1FhasaBQO11KHCdO7aBWB27tnFxBTlMgcOKsolDhlqwd8nQSVZLdCCx0aHBvMpEQkCZSVDA/kc5SE5NG2ntFHBQ/SFyHTcFdQ/jQJFuCwvQDt1C+zASMGasmyqAR8/FjHaSL8de6521uwSGd6oTmpCcDHEFgNgFRE74ZulOC6+qDRJ8dMNaB52sI0WNe49MDWgjQxJzxmJvUiToBOkvMyVGCkwT9NoHZT55mdu9EixdSk7GnSlRo8M9Tt0sVGcD9vR43mK2rEtPVJslC2dAz7VXMlQZ8lJ5sfQI+u9xDh7qBHAmHOMFpxgklE16VjMpRYl7jf2EvNn0EbLJm7kiKHXcmWG1qEtPUrsNPrj5SPQMWRjKz0UB9EAtvyKzqXWUHSpCb0gbAf8a3XgNSY7KwUpwddcFF9zvkDs6EpyXUtSwue6rhBzQWUUJ1hQGXfmFU83K1imqUuvRBe1KL0BuG2vFCdr+/vAQ8W2sIMOFhsNry4gQgSv5CihBarPhMxb4nO7Qns41RWagBs0u2wHaNMkwS2VHlyU/IBtqGa/FFQa7MG11CiRizy6KuWRsKXiolakQ1/yFBgjbKBrLTrcJOw0Uw8s5ATTUajfYBlQDSlG8tM2ULXNwCEtlehQSzEU2FqLDlfIsQcHtlQiRC2iwmQaBpYN+6C1plpVQsqHR+GHHlProcZZSW6FDT4Q2IcLOwh4HDDSBFHQTg4F0J1ogyL4EbehbjKzklY1HjjILcVp0G8eMuCGyG9AUulOY8adHqjwzRCVLqoZbkZFjOK7a/ilINWOpAOuxPGoSzVSZLQtqSJG8bdsBUapULWY8apUt2FXYey7ZJ4m2QNSF6lURaNKacL65R6U02yDr18KeGbzdtxNVuCOI1pykpEEXBxqOTdQCkS3warU7yuUZATLWSA1EdMRhvCvYbFxl5shhMaHgENPeu1BBh31OgoaoQLT8sogVWEOAev6OjzkZSlHCf29vnD+6HIpn72C5tnYJnyvr50/ipQ4TtLNaIOk4Eq+qeCqpR6TllJePo1TwrTVKPlF0KR7ywaphpJ6vw35gSHPpVJwkplUgac8Yx8TrDdZkSvFNCF+mdEKfB12xCLfAfibLGbf0biTUo0e+ZcEK3pQYT8m+DGENjpCcZwDjlUfN4D9McLu4JJ2mv79kT0xpAWNwi7VSJHV0RLlFhQNXB0wIWpNUvyviLESVR5OEi7xQ6POPwZxignoa86esDuMOgd9ig7zGAncNYsUnGTNglHm7lDjZD9vQ4aWu1tBbIyS962owpz1goQrokqNEll35C+gszxsZt2NOfwsjwFotUxGQy7FKIHfM7GQIlFW4DV1XGuStzfCcQ42OdaRDgPQqLlRkpooO6qFrXdmqDNjIvTWbIqZUeIj5khJcJIsqRay2ikgN7jaKkzT3h/REpIUNX5KUhtX1QugvZJppUaNjNk1ajlKaIyTo2xqtMOjtmNX50dhYYtGjxS7TghDA6/TwYjR7/ka0d0gN458Te9wSMTf5Uy8TDK8nrKxBCnBf03UvIDWT55qOTpo6PlNDS9Kgd421FX0jaG2sBKcoo1VORdWDoTSIs6ByKKn5AFYrt4AW2p0yKZkDge41qLGRXRgG0F6/7UFjuYfs9ipXWQlPl62XclOnnBnSvuwmFEOsRvGxUwmNYoTpJEi1WW2yUly6Vvgt+xBLtHwukne6FFiCxXOw9rnajnyra5YPLJ4k+qD0LDKsCrNqNKkxFfXhN5kBf81Yc9Y+EpTfoQ/GU1C/OrcdSTy6tx1amhcn6UUnMRpiXEoqUNNH1YSzVnVaNSTOBsUOOKkqbDpZ0x1GzDedKnuASafKwXPkRPTlOIkS1j4wbsNNNLhu9txHx5SzBW3EaRfcZvvwR2yjeYko7b5KtxR0GhOMhCCz21uqHHObh6Evcxi6IlXLWbZSchdavqLTKoR0vupFde1Ih069NTsBhnl5Ow2qu8Yly/wOz1LCYrDXMwiGMHBajOag6nRvKxVC/aZ8HsESh12yY0YLXCegE6jcYGNGC3wpuAYx3+74FIU7UTTEQZcIZw23DEA7cjhEQbc6c02Kr6oJEnhF49s8W3O8V5SS5AWXNUsmfSXT8BIsMuvdE0izAojHjxghi7rBIeEHQu0JE5UeBB+GW3SAnihWgteS2IcLDQEn8UneNhGjBTYXLt6KdZ4L6uRjIzkBPDaLYG23Crxi0qU1oDvUkRgrhYPHElS+CX41mcHHOne5yFo5Zb8ksFv1nDZlSrPkE6LHDChuv30JsbrNZVmEpN3G+iRdg43yql2Q8Dx15wtE7wBMonXlSAt+Cp6YNC6P5dcKaJU/g2gy6l6zqMc5GhxyC1BanDV4neyleT7BDuku22AanhhCZMaskoy4xbFXUdKWeMZnWQt+c+NXHcLFuWwE4EcC1xNUnzgXWcONsZlZwO4ZnP5ZYk3LRlFviSflMwXwUtIPfRIhaRDBuilB+qm1UhOsV8VfJMvEMErOVroIoce1uVS13qk2EU0n0NPYXS4LUFqcFzqCZD1JvIevcW17GTtbkKkyyXmhqmMkVaixAaAj59tseOcQDuAjXVkqsOOemrqDgbAD07tNQPp7NQdjIEn7/Qag5TI0zUG/VrabvivHdYpRPzXRPw1yR5ZnphUAmxD8C6qdczZclPtZEbBr671mOS5m28yg5Bdbr232U5hEPB6W9eQ9v22Exlwn8NOD+8YUeRs8ncFfFNoN0w3uQnYYWpviHoKQ8DX5LpmdO/JncwIaBmwx5BOHfAExmBcpetGJH136U5hCMrluq2Y8GvN7/DrdlsBv9eY08EX8HbjZ69iAuos6L+TdwJToJf0ukGe9i29ExiAcG1vO1rSubd3GjPAF/l2oj6dm3wnMATjal/HEO/dvlMYgnTZr2tM322/ExkEvv63Y033/t8JTEG6ENgxpu9G4AnMwbki2A3a+e8InsQYpEuDW/b03Ro8mUnIv4/3HuHJjAFX5Hms6dblTWIO+Krhlindu4YnMAN++bAnAjuFEXYdy2VRRIvHldS85UFl444ASQ1L/QU3QSuULuBBI5mE5wi5LdeXY641io8sewjLzPLQl5pppUmIH8sd8yceJ8skrODQQ68kV40kIfwqWQWNMR7oUooQVu5fWI7WwbUadd/Oedh05OEtpQhhg+9Q9dDCitlH4W6KxXv8d0+qTvf6lSbclWegxB94fp1HYpOzuyQLSwDqN6k6aSVWcSLzLaL8FlwT25Nnnsw3BQufO+vniaZOox88sLh4B7UgbGxpGq0vmVncmDVPaD5EFz0RiSNJB6//HwpzqUSIyvH6htIi7hZyv5+o1SwOsKVGh1wEXjjexQVdMz4G9SlKN0islRQqrDP0vsvlBucxcNytH6YYdOdaPOytcsEOjBTgpWpaqa9CKuerO53e/pmHxdtayErQ5MtnHFD5PQiurmhIWeA5KC1mdTVDpUWGCzl2psMLPm9mEDh8ZmjBAqeFUaBfAfOCBxc8MQxCG6XPWG1s5Khbeh1cGNfGhRXE+UCduSG4VFU/SLIQV0dsqPvFYVTmVI1SJ6zxTNtswQxPRWxxelIV0ED1/dvQ3/igUSFAXG7+CDsA1QKsNAjw5KqiPgntCqU1lWI1L5G2rIWeB0Wr/NB5eCb2AO7DYyr/ExQpcFAbHQLMlEVPTHzJwGOUEeIZ1SC1CozpWYigMretcBmPoyLo+CcLrxbBAXTmRrXmCNw1lY+S7JlSPg9bCdlQB0oGsAKq2qZ3Df81l58IPXzRIU3E2tIiwQ0NfzicoMDHAGD4FsNBBC57ByCD4wYOIyxiMIQY6GJyCSHepS6gM+bkfBE0JKrnaCPKQcuHGuvAFQprO904Q/57OGejg4+phl05NK4SAQVVSutGiQBV7x3BmI0KPqIaz4B8lQQKXPsi6CYyJj7wPNRt2MBKSes9WvIc5DgcgH8nOxgYd25EaAB114IjVjKEkNBeWmPS9VWU3knZHxWg/MzqSvZ/HFLlgF+UamTI8F+edIjSiLjNKvDb1VoifUxEiHtAPUaxQAo82LLGAR1mqdsC+xTCBg128uA2uNBkhYYNlJvQQrO716co/xbUbOZBii4WmCRhAYGyI8oW6WkulRjKsyueLZOQa4Sd5ykab8lY0HGQXbCDSiqsFZ2G2tqYNwVbhROrp0l2gqGXfbW5DmBXfNmNNORGZrGa3tS5g6EFAR14S1vHP6U2yGMxwpwkxPHTAQ/3+4xATJMspJi6A1nqUGGGjqRtTNBwOgKz7LQoqGUnJcZFe7+UGMELZQ+zqtLpfVjooXqUaoANutTPgTqAXeZXt01fNDm8ZNTFhN4WNgQaGFtyISGxpSFAFp7k5EJCE5yGQYs8uiqV4bBSbFGLkQCHHsHgkoLuaRxGTMMuNG4zpoC7jIcgVcD/KvzGEhdViUFvKxkCDjxB3QWFnJw+BvA++NTFLifwxMUh3G9BV424mIC7RYbw0rBrk10+yGXJQ4A5W4bd1uIiShnCVhThlyS6mNCbEQdB9RGQ6lP3YVHcFq6WUyXqkHjuEHRoTNxlBS2IBxGRBiTiwSgwdN9iJPypgefSuqAY59HuAhx8Dm0/Nuz82V3gg8+d7YeHnTfrgW9vQOX+Pih2WT9LsgVdr+UzgGOBXLoDo4ex1TPN1beskj8c6EbrFrbRI8fO2TqVdHjcpSAFuNt9C3bFVyu56wx2ozgKFF35kSei9P8GJc75EA9KUVgaXbv58J2AXnaoI3AsdvEdr72lWKudAce8jDTgKWHPdwseuNjwGKEERSmI3PLtt/ITKyLAK1k9ThInj6QR+sDX0N7h0OmzURa1XnC71i1Gc6qLnxt6qMQY8PJICcwmL8+PmKDV4Ud69NITtX37TVQj9y1b8KCb2lwBircxEZe5XCY8BbdtC+8gEVEjGNywVqv1gv+SxHHgYsmH/VjJkULfZL+YpcPdZh54sq4fX06ERlhs5p0DdgkMuQu9M86PD7subhw0cCHVhsZYR3mh20PI3XNSqKN6rpTc95CcN48KSX6SXp9gQ+qGXtSywW3dbkaaXtJrAbSr9OPb/eUry4UcBgLXftbTP1Rgu80FjG3bjYQflO3AQuOyI3BDI50dVlCwcwQoIMjQYYXGGfy4ztuU89W6eJ9EKX+ozgQNAO+qULxdiyhN51HQXRZ9hAeWZlgTexqwb4PFltEmLX4NPFCp14RSF3S60g5mrJgQ0QOqBY0kNbx4DLtioBe9EqQGD42u9YKDAm3bwe0B5pYJnj6x8LHFFSDx1+hjni7T9CrlWVDij4fxwKjK0WVRqQa1dKv9+ibzPBIstATHR68FQdU448D1Of1Bk6WPulHDRbY79J0pJJIfCmlr62mKrlzkycMDy81K+vpJScEZD0pVYdbnpWpQC9uNR+CU7pCDHdJ+YKc/qAngqlxFBO5KOhoUfeMvUSaegzLx/HgHtV5Yy3barY871tMMHnetR8y95HlIcUsPdalGzPzPDROBxS893JYiOrv9Ht4HJqPo50h2K2UKqLlA5SYOSSxt4A4qOXNzShIHp5aahurNL4ilSBTYBSxcVwgfVGWzIbWskkJvVadrsu/FdZwUQRc2NQ+TdFKePSknQdjP7aIdOGJhrdi0FG6xQxsVUu4wDMnkvyZZyJTV5myUiFDVoWcpAmilQ4S5TjcPSdD+sQ3aKBGhCr7JF+w6Zauw5Xcb2OixWg8PG+fq3s4o0L20FxWUZWqovWVRrI4l/BR27l/nPdOikjxWRxRCTgIcYcB3ttigNHWjRIQa6nVvg4Kc7sOYDyw0HtQGlUroU0Mb9a706v9ipnME5CpOAFggjEA3NxEaepwFg1EUliIRukDrIIKig7TWioH3E1aPUqwTf1OHxYWOBDXUQS0T3Hi6bfDXhg0i9NfdBhhYlO8CQiryhwDXOXtK+EbcJfM0fAHbsFZ6otYjwRZFlBdflkv5coKRtRavtLBw26844G4C+3GKV51D2tEBO4A3Y91OfQ5v2HDp4iqxzkWucGB3mc1XSu4fSVD+TZe51HtOwnNv+rBbXfY2yoKivvWzSJ3V4cqjTKTayxTs/2tJULxSkAu7vXw9F3bv8qO3W24LeuBM0AsOmQlGYq94HnrwiZ9bCYKWBiPBM46KDTs0fgu0/Rb+CgjZ1c+SpOPBLgl22VDuB26aauhAL6FO7vtarp9+TdQKCt6+zZleIpXy1fLsqZafwqh7tlrzPMqT9CU4w32rWUXzBbCc90HD8tILZZn0PhHqVUHob5U3yjInbsRpDCr4Ar3PSc2pOpr8KoLeJVWn61IqZSHQqdnCVkoQT6YP1R72/6HKEkOWNOZBrOWgvbqO4jj4VFOL6kDqrCqdoLYr22arrz08RGCjGi1geGAMbrVFuMQhrq7Ti0ihQzctXd68VCJANUX492FFJTapEYKUkWwHNf5alDfMSFG+ZEJfSmBuuADCCn0ZQS1FAwtxrLdgwR51D+zF2ezksOatW9Y5oEidOTPI6jyKNgm4eGUN+WUW6yTIT9F6LTedYjfQHhFaZBAqMqK7l4rjz+z5YzS30gWC2dQEm7HntFQL6qPtBhvmfs+WSea6XVEsiG1deltuWRqhGpE3gtPRE/wYlR2T/h68YB+jjbqvJEcyRCqmjSIxv3ke1wKhPz2hDWs5R+bINmjN6WxQq797fqmrPlu5giA71GKw4KaalFW6xLb8I4kfGHKfetaaU/0e6+SvKX/4a1mXhjAZH3gkKS3QRUfmRChxzxH4taA5DUoUfCp6ZPZJyAUzb/F9NMdhF8y8voUWpKdPU4mO0ecNe5oWRo6c/Je0wKJ+TIO30LsQfynkYIbZ2lwJTtXe9cW3d3JQk6utr/L7nnkev3cLdoAm1VfiCvMt6/JbYGU8u9h5qyILmL9SrgSn+pUQx6GJRqD7x0ToA0HWaYL2RhdSVM8BpSi9FXyBxq6lpiAuP44IvqgVSfl5mkZrwe7qs6HA/KUi8LSp0fyqdEbXmspdQB1oRrFDK+vLZnhkK9Pas365WcmF7i1bMqm8kGZdpcl6zqMcpXdJ/UTp55W+7GqW/iS2EZk0rSX1tWHoxtSXhk1uj6AxRkxriZy47/ln9vwP+c/8GckOOYUXcjf0/FyJklqxKSh+jk0x8a9hzvJAQK+F6Gml1kp+Eg16mat/C77zYCd29yQTKDnoGJOx3Bu5rFxEBeICpJacZgWinIPmBu+vck5NviNYoCTNXd7rSpLags+dC/pg+OA7+sayqwfa+2kMG9Q/t3fQ1LaYqsSbzPjB1E/yXm4dk9T4hTGsMt+QZMYxpn6kWH/Dc/UNE9inUviveIznrS91VSr/QupO4q13bFF6RTsrCckerQ3MUtrdJs/JCyj2qKjK1L+PSpfAfoO0LVJkovdGnRKKN0EavYlmx+9rbrbnOODc7MiJqXXZ9aVsc50PhDUvalXV8lp1itlRf+OXzMwiWBaoPIFSbwJ2c5o4atJDaYU5WHyynIfSHtTOJB+bqhfd44w9WmuCcUfdJfoh5ZE6BObdpijsMzTD6ZXqslSd16rUdnxky+JrlGE0v5JLpdzayJGSq0sHkAZ+rTXBuJ+oYoXiJis4ErgRlB/ik9GrLOOYP2c3WZqg9Bkjuyplk0qW1JLmtjasH6K5r22KX0J/m0K/XBYomTxGUaFHpSIlf8qip06UGsEKrTvxrlqlyxv/DFZKj1I07pkpcnrUt1UpYff88kmuvJyKbZgdVWJYwSNLeTp72sVyWNYAC+Z2sEW7aezD0WEmaJ8M4Gj0APKb7JeE5Wox/IJsRJI9WspT2IP3hk+T91Zx/x0j4FBhb6ijDQ01Td/ZrKftOegRQyU6acRQW4Gc/qONmDD7x7ok6pbxPEZZOFlXROW1KKUVfM2yyznfFGjZfEoxUoqTZO6pb3u3Sb9d6kI4gWrFXOpGRncyW1j8IUnlSBU7l1zC7GDxUmpuak1qG/6d8Y98gVW8pBQfGE8bRWr+mwwnmVJpyY+QZ1MaZrTZwGBPMg+or5ITGeY0oCTlNDbVLKAtUAUYyg5UG1QRhrJkcivwOn9twzTvQG0B6qtQGzHdG6HtwO9MU/SkdSTKxB7tS1LpSZhJYVpev9vasaSylabKDmssozNqUnuMYwsvUFsKThOpzdlCyl09quM6hHxZ0KwwwgsjLN+Ziay5Vvf6qZNMVM2ICp9oV1MiX1iMnaq0oNTXNSkqnvJk69PatsyZeNQV1InAGNFKRV1BbRQn4L9lYpMWGGG5UjCvBSegJ4hLl8oTx6Vzpo6WrA8Xwfk9lGRkS9JaoGbkj3LMx1loGT0JXNCvsnK2TqMF+5QIsWapc3Y0xAAtunJEaa0QqHXrWm+imvV8Y+VbYrBvrOxKYnYRPTHUN1cJTvbeikXO01R5/KIkU8Gg8jkMO7T0opIu+KKWprfonl8jGlFwRs+tpxzMRZ9RnGq1Z74Nq/rBqE1R/WAyAS/TVKPfZF+NPIYJSjhKU21Fkq0rYVprCjOSShXGMFZEqnJaK4pKkZj/vzhffZBfyXOV/SkHQxwj/pCySy2r0j+NLKklj/z5Mo4/Jtk3NP+90oziWK4mvk3iu1ffJ+eGZZKv3tfFTe/4d5XSrSPXmIYtzBc1dU9z/l3leOtA9tTWUhg2lQ3NT4UXOVK6VkXaZLZc63RzVDNMBvtkFtys0C0w2YDTWZAt0k3M0F/4xOhO+n7fZEuObMSST0ZvtnfvohxxkShlzS5vHuUTrRSVJXj51NqCafKp1Vd9WevYORI4r9WouasDjuRrfIdShqVEq/OM5DsMuCxpFytyvlrjjqZrLTnZO0x+8FRp0+udO6UAbu1IBpJRThBjEhtUOAHvXc8tPWr2v69Lj3J5ZA7uSnCzLp3Llfo0/Ypb9QgoPwq3yhGof5WCPzykehH1i6qkwfEyG1GF/9iI0lvxXyxzrvmAGvAHyyCXfYxk32To0eFacpqVk8l2q73NSJFHo1q7nCeIPrbsEDSGCBpLeg6//yz/ChuU9JNkJ/Nb/oyrKE3n0eLbrpQeiSlwTXAaAGsEiFDLsybUyQa7IVoPUqGpKx+cq/jGgVWPUWKpV51lu0YonUcp8er3fXc8ZyyC47mHemsPfJmYb1bVO0a3uogHRrRMzF/UokHDpdt4W61QSyBcE3R9wWT8JrKCa4GJrUxiQ+hVKD52+EUoOzCHXR3Siw29OGQc+Tr5yB8+BR3F7yNfJ3Jagx7DP4p8zpY8N++qGSBu9aVXYBOMrlMRVOpOYcvdcyJHOkQjRCVIRw+5DsHDjnMZwjhy8wuLW2YKduDspWDeCNLRM3WwS8Ikvb6wGk5fCeaNICG9jnJ93dXL4MPWSutw18IOvHdPWLziiZZ3mfNFhNY1tNok/eKBcfmRK30tZODhHh5+qbqK1uaySfABH6Ps0P4uFmMuJkvJqVaTOrU4Sm+lDMuv+Gq9+zm9HiNK1VyrLhpVOjsyU+pWbU50H4D/GGW1W7U7qVUJ7WivdRCMaC9zJrQgoHh7yAJQ6fZoC8xJebcmER/pRzCn5eWWJq0NeIsGrTbJzJDV62Ms7EZsGurLLNbJjzgDkGVBlMWRJUxrjXIMfkpWaNOaPgZaPruSmlPMawiHF3isQD26YJQd61ag/q6IcoyO1Y7Ni1qXzhY5fcZfsvTlnqnUsShP0pf3iVAnTcHtUdpcaheNdtxoU9pUlRf+kjw8pqoEUAeSzDnDoZWGXgOrOsPH+otUaMkcPAwvOdzR2nu+IDSx4IuJ7dJzcmC0om2F1oqNFjlzmReJs4MqNcucSPr9E6iAtZ8fWr46kt24bgk2spX0xLtZy6JbVXf3NcpUGQSmObqebx1lfxjd6WxRhtzAvfZtU5QdCa333mfJlw3Gu9I1hW9o3xlTUIW3qzJ60+yoZBNZHgYE9MLa1tKSw4qAfPBYJUCj+X2rKxQzfKspcmvKSRvx16im7Gl+DXPmwXWe73otSA+9eY9ZqUfLXq9cUcjrlSot9z/T/9yw/CXopAwf+T/Tfyo94EEZo9iLaI7lB5RSU/j//jCJpViujzKvlMjr4U0gCkgDbJ6jzGxS2/9QuPpZIsAPm2zH+4bVE0Qw/86K5uqlsJRJrwQR7i9RFqe7vuHlQ0RIOrto98TI+jEirE9ywE3UvYQ7e0zsJ4ngPpee393AqqeIoEy11Z2cbDNIBnGvDBH2XcDZB+YZKqB/ptfm0rKgZUTncSzMk9Ma8XKd1FD6s8to0UMmP7ozQN+E/5f6fJhdv/3AfnJ8Qyg7e1jeRSJpL1DHwszVswHL0S04c/k//XvK51Eq35y8WGwCqKTEg5YQjQQKnHGOqX3t7r+bfjQ1jyLCGFdmMJDxXCJCbXL1oOOVHE1knt3Z7bgFJ45efhc7g1RPoSAseb6KVIEBu7n7sjOKeVoV+CRit7TFQSSdGZr8sfvvZB435/v8gfZTGVUAECaMHNDeRy9BvVg+KvsPZieWip/kA4+hOCv1MDLQf25U+DYPRfqneRwZ6p7H4T9awfF/tn8w9u1DkgtIZ3qWGkulQYMHwULG+T8sCu5QL/JZTJzUU78wFie0WGE7zt1afnNsbpMIYhJaYFMLoIBZEYrLZ6kRuJC0IhORksFdU/I8eUiya5WI/rIzmnmYVQ+jAMnnBFNLgp1p9JNxhNfRy7ycoPeufBbzvWtq1Z1rX3ckCqlL3wKlzs7jq7sit48vGItkHhbVwyhA9cniaeD7Vh8dnuK+aYIVm3VV6su58h/tzKY1ynvni1oDB6/3rLvRcKCT7QbQ3PjWLki7R7IGUDwnhu3CE3g+2ABUOSMHEa3qZ9FwvKcy7cIUfAbTNjCVVxk0musnMcdyOeQ9POgiD+ds5bE85eMh5ycPQ+kATygSKx9GAXqOkuLvcnWR3r1kC7Z7M6nnN+p5UT0finX49vjcrfpW/iVT57IzVvV8WdGCjgViwgSKY3PL+z1XE9482n0AlxLmSveCF7UEFpyKyN3zS/skBROgC8FUTxfcOUGBVWIowA/VQc7trKcdtoIOHhXYFY9ZYDu2ERdSirYVQzfVDibmS+MD/BoVjyiQayNEAnof/vq0UQlfnk9RkoFfoJUUoXqJPtcFb4H7l5qyKXMDb2TaqKo4VR0aULx7uU5DCBeVwPxlx6NCtoPdqOIZOder3JQQrqR8PjPPY2GpXme5g3b3USlXtdSwfEEQN1UbL3QQRB73oC1E2DrBPGggIRsp2N7J+XpVbaevaqxO+t/dWSgV9NWM1RH+mGj30RwEVkRzbKxtNUGjfVHAGqCteKqCOKxvm2dRu7e68Ent0r5k76LFN/mc+jk/RdkmSu/zKBOmylNnqQV5GjdZpOR5Njfy6tdeafmikX9s5LGMqu0JQa5psYBMbvcHHhZLMk8vOTSa1I+0e1d0mNB6o2DFL81xIje7/3hSwDo8JIH8gEdN1lhkpWQ9RXmiSmr9IFFQRtb/vJEGxuz7T//2vz89sVzVIsuPHv589POFfHaZsDSWOv/9U7U64quV8fbEfLHR//V/yo/9ytS9OurD5tP/+vanN//99s3x25+PzmdvZm+Ozn4+OT17c/jmaPbzyez4f/7nzX9Xcvqj+n+oVJv/RUvN5F9Hb07Pfz48OXUenHUenDkPHsq/jt+cHf18dOY8d9h57tB57kj+dfLm+Ojn8wuX9Kjz4JHz4LH86/TN8cXPFxcz58HjzoPHzoMn8q+zNyczSep+40nnwRPnwVP51/mbk7c/n56cOw+edh48dR48k39dKNSj0xPnwbPOg2fOg+fyr9nbNyfHsnVcI887T547T16oJ2c+2IvOkxduD1AdYnb45vjs59nFodsHur1n1uo+qlPMjt6cnP789q1r68zTg9wuNFM9Y3bsg551u9HM7Ucz1TtmJ95v7nalmduXZqqHzE69D3e708ztTzPVS2Zn3oe7XWrm9qmZ6imzc+/D3W41c/vVTPWW2YX34W7Xmrl9a6Y6zOFb78Pd3jVzu9dM9ZnDmffhbgebuT3sUPWZw0Pfw4fdHnbo9rBD1WcOZQ9TI4b7bLeDHbbGKNVlDo+9X+wZp9wOdqi6zKG3gx12O9ih28EOVZc59Haww24HO3Q72KHqMofeDnbY7WCHbgc7VF3m0NvBDrsd7NDtYIeqyxxe+Ib1bv86dPvX4XnfyH7Y7V6Hbvc6VB3m6O2bUzmlnR65D3e716HbvY7e9s0MR93edeT2riM9/8l+fSYnQHcIOup2ryO3ex0d9s0sR93eddSaBo/6Jpcjz0Todq4j1V3kSsYzax91O9eR27mOTvomp6Nu3zpy+9bRae/8dNTtW0du3zpS3eVIvsiHP8+OW83V7VxHbuc6Uv3l6PjN8fHPp4fuJHXU7V1Hbu860r3r5M2pXHydtR7u9q4jt3cdqw5zdOprsONu9zp2u9ex7l5nvm8+7navY7d7Hasec3SuJubTC/elOO72r2O3fx2rLnN04V0vdTvYcWupddy7mjj2rLbcDnZ80rueOO72sGO3hx2rPnP81ttg3R527Paw47Pexchxt4cduz3s+Lx3MXLc7WHHbg87Vn3m2DuMHHd72LHbw05Unzk+9D180u1hJ24PO1F95vjI+3C3h524PezksHcNddLtYSduDzs56l1DnXR72Inbw06Oe9dQJ90edtJa0Ks+c+zbfJx4lvRuBzvRHezE92y3f524/etE9ZjjU9+4e9LtXydu/zo57134nXT714nbv050//KOIyfd/nXi9q9T3b/Ofdin3f516vavU92/LtSofXHmrr9Ou/3r1O1fp7p/ederp93+der2r1O9/vKuV0+7/evU7V+nqsecvPXa3O1fp27/OtXrL+9i97TbwU5bm0a9/vIudk89+0a3h53q9ZdvsXva7WCnbgc71euvma+PnHY72KnbwU71+t67Uj7tdrBTt4Od6fW9dxg563awM7eDnen1vXcYOet2sDO3g53pBb53GDnrdrAzt4OdaVeEXEbJ1cy5OxacdTvYmdvBzvQC3/s6n3U72Jnbwc5Ulzk58gxCZ93+deb2rzPVY7zL7LNu9zpr+SVUjzk59i2zzzyuCbd/nake411mn3W715nbvc5Uh/GulM+6vevM7V3nqr94V8rn3c517nauc9VdTk58Bp93O9e527nOVXfxrpTPu33r3O1b53py9Htyun3r3O1b53rwOvU113m3b527fetcdRf/Svm827nO3c51rvqLf7F73u1d527vOtcLfO+S87zbu85bni89PXqXnOce35fbvc6198u75Dzv9q9zt39dqC5zcuZbQV10O9iF28Eu+v1fF90OduF2sAvVZ07OPcPARbeDXbgd7EJ3MO9y9aLbwS7cDnahO9iFr3dedDvYhdvBLlSXOX3ro+72rwu3f12oHnM6803LF93+deH2rwu9/PIusi+6/evC7V8Xqsf4F9kX3f510XKu6uWXd5F94XGvtv2r2sHq91S+9XlYWy7Wt7qP+Z2Vbz1O1rctL+tbvQrz+yvfevysb1uO1req85x63Q3m39rPt3ytb/Va3+/yfOvxtr5tuVvf6g7nmy3NP7Ufbzlc3+o+d+zH97hc37Z8rm91t/OugM2/tZ9vuV3f6pHN77R963G8vm15Xt/qpZnfb/vW43t92+p+2mN/euK13+fg73j49QLN7/r1+vhb3U/77f0L4pnPzd/282vXvXdNPPM5+tuefu28P/Vu2mY+X3/b2a/996dn/uc93a/t79cufP/Keubz+Ldd/tqL719cz3xO/7bX37j9/aOHz+/fdvwbz79/9PC5/lu+/5l255+e+8bOmcf7P2u5/2fG/+8fPTwRgFkrBDDTXv1Tn0t75okBzFpBgJn265/5ZruZJwowa4UBZtqz712tzzxxgFkrEDDTvn3vmnvmiQTMWqGAmfbun8lX9/zn09ar44kFzFrBgJl28HtX7TNPOGDWigfMtI/fu3CfeSICs1ZIYKa9/GeHXnhPv2sFBWba0e9dvc88YYFZKy4w065+/wJ+5okMzFqhgZl29/uX4TNPdGDWCg/MtMv/7Mi3c5l5IgSzVohgpr3+Z8fe184TJJi1ogQz7fk/8+6cZp5AwawVKZiZUIF3PT/zxApmrWDBTPv/e6LSnnDBrBUvmOkQQE9g2hMxmLVCBjMdBTg79b33npjBrBU0mOk4QE9o2xM2mLXiBjMdCjg78329J3Awa0UOZjoYcObbWcw8oYNZK3Yw0+EA/0p75okezFrhg5mOCPgX2zNPAGHWiiDMdFDAv96eeWIIs1YQYabjAj0rbk8YYdaKI8xMIKEnPcDT+VqhhJmJJfjnTE8wYdaKJsx0gKBnxe2JJ8xaAYWZjhGceec8T0Rh1gopzHSUoGfB7gkqzFpRhZkOFPSsmD1xhVkrsDAzkQX/itkTWpi1YgszHS7oWTF7oguzVnhhdtLv/515IgyzVohhdtLvAp55ogyzVphhdtLrBZ554gyzVqBhpmMHPStOT6hh1oo1zHT4oGfF6Yk2zFrhhpmOIPSsOD0Bh1kr4jDTQYSeFacn5jBrBR1mOo7Qs+L0hB1mrbjDzAQeelJ0PN2vFXqY/f+k3e+SHMeRr+l70WfZWIXHX5872Gs4tiYDSYyEFUTQQFDS2Ni59+12jwarf/lGneLup4EQQ0d1tWdmZDzhHqEJC6eMYA9F8KGEJ/CUEfShCD+UEAWeMoI/FAGIMs5zPiCIIgZRxnnOBwhRRCFKwMLC9aECDlEEIso8T/pAIopQRJkPJn2AEUU0ogQw8MJtAY8oAhIljGHxfR9IoohJlHl2+wIqUYQlyjzTfQGZKEITJbjhMOkCnSjCEyXE4TBrAqAoIhQl1OEwbwGkKKIUJeThMG8BqCgiFSX04TBvAawoohUlAOIwbwGvKAIWJRDiMG8BsyiCFiXVgu+8wBZF3KKsByt9IBdF6KKERhwe/IAXRfSiBEictjhC/glglDCJw4MfCKOIYZRgicODHxSjCGOUkAl+8INjFIGMEjZxePADZRSxjBI8cXjwg2YU4YwSRHF48INoFCGNEkpxePADahRRjeJnky3gGkVgowRWLFxoBtooYhvFjzJbADeK6EYJsFi0q6UAbxTxjeJHni0AHEWEowRarI63XjCOIshhgRaL3pcNjMPEOCzMYtH7rgFxmBCHBVkset81EA4T4bAQC5z0GACHCXBYgAVOegx8w8Q3LMBi4aZb8A0T37DwCt4NauAbJr5ht2O1ggFvmPCG3c41Cwa8YcIbFlzB20INeMOENyy4ghfaDHjDhDcsuMJptm6gGya6YaEVXvA/h8wT3LDQCudfHuiGiW5YaIXTLcsAN0xwwwIrHG3MADdMcMMCK3iLqgFumOCGlfOWAQPcMMENK+ddAwa4YYIbVs4bBwxww7SwIbDCaTehUWWDljbYefeAUXXDpbwhkg9vuljfIMkXWOF406UKBy1xCKxwvOlSjYMWOQRWuNN+NaMyB61zCK3glwWjSgctdQiuKDe88qnaQcsdLG98eOlTxYOWPARYlJvhfw+5J8BhIRblhtc+CIeJcNgWDqzhA+EwEQ4LsSg3TH4QDhPhsJpbpDB7QThMhMNCLMoN0xeEw0Q4LMSi3DB/QThMhMN2MQQ+t0E4TITDUjgK5h8Ih4lwWApHwfwD4TARDqvnPesGxGFCHNbO29YNiMOEOKydd64bGIeJcVigRSn87ATlMFEOa+cKQgPlMFEOa+ciQgPlMFEOy0KJgtW3BsxhwhyWzFHwCgbmMGEOS+YoeAUDc5gwhyVzFLyCgTlMmMOCLXi5wYA5TJjDwi1KwTsAOIeJc1g6R8E7ADiHiXNYOgduLTFwDhPnsHSOgncQcA4T57AsojC8g4BzmDiHhVvwco2Bc5g4h4VbFMPlWgPoMIEO64m8+AgE6TCRDsuaCsNHIEiHiXRYz+lfoy3gBtRhQh02snYaN1cZWIeJdVjYRbGBsyDADhPssCyxsIk/AmiHiXZY6EWxhbWXwB0m3GEjsxCzGLzDxDssAKNUrNUwEA8T8bCRq86chmAeJuZhI+vG+EkC6mGiHjZyswHfycE9TNzDwjFK5UQE+DCBDwvJKJUTEejDhD4s6aPyzQzsw8Q+LCyDS5QM7MPEPiwso1S8mYN9mNiHpX1UvJmDfZjYh4VlcJWUgX2Y2Idt+3AOAFko+GEbP/BuDvhhgh82s4CRLwPQDxP9sNCM0vBuDPphoh+2cs9LxRQA/jDhD0v+aHwVgH+Y+IelfzS+CgBATADEEkAazmgAQEwAxBJAGu4WNRAQEwGxFJBDGgKBmBCIrXwrxrsxEIgJgViQRuHKOQMDMTEQy0KOzmkICGKCIJbFHJ3vxsAgJgxinvvt+W4MDmLiIJZFHZ2XxQBCTCDEPOtqOQ9BQkwkxLK6o2MegoSYSIiFbJTOeQgUYkIhFrZROuchYIgJhpjnFiy+HQKHmHCIee7B4kQEEDEBEQvhKFxsYkAiJiRiQRyskQYkYkIiNYyDNbKCiVQxkbrrPrjPA6hIFRWpWfiBlRMVWKQKi9RbVnjjdVABRqrASM3KD649qEAjVWikhnUU3r1fAUeq4EgN7CiDZhUVcKQKjtRbZiFeBxV4pAqP1OQR3H9egUeq8Ei95TsyXgYVfKSKj9Rs7zRpmaiCj1TxkZodnibNCioASRUgqdnkaWISgpBUEZKafZ4mLXJUEJIqQlKz1dPkHAQjqWIkNcyDH4gVjKSKkdQsAMFNBRWMpIqR1Gz6NPkaACSpgiQ1kWTiw6CCklRRkppKMhfNyyowSRUmqZY5iBcBOEkVJ6npJIt/BwAlVaCkhnwU3lhWgUqqUEkN+yi8NasCllTBkmq5NQYnJRW4pAqXVMvFGr4Zg5dU8ZJq512pFbykipdUO+5KrcAlVbikJpcsWmyswCVVuKQml+AOgwpcUrVJVPAHt0eo1CdKG0Ull+AWhUqtorRXVHLJ4icJ9Yu6NIzKFHS8CrFplKRggonzVUSNo7RzVIqJ81VE3aO0fVSSieOzhBpIaQepJBPk7ko9pLSJVJIJe3elPlLaSKrmlJAfJtRLStCkZl2I880c1KSKmtRQkOJ8Mwc2qcImNdnEOQ+BTaqwSU02cZzZV3CTKm5SW27P5zwEOKkCJzUcxFBeK7hJFTep7VySWcFNqrhJbeeSzApuUsVNajuXZFZwkypuUltWBONlBG5SxU1qzxcTvIzATaq4SQ0HMZTjCm5SxU1qP3dtqeAmVdyk9uwMhI8ScJMqblJ3fQg+SsBNqrhJzfoQlOcKblLFTWrWh6A8V2CTKmxSsz7kxlcguEkVN6nhINz5poKbVHGTmhUiSNcV2KQKm9SsEEG6rqAmVdSkZoVIwQsA0KQKmtQwEHuVV/gCAE2qoEnNEpHCDxJAkypoUgNBDOm1AppUQZO6W1RhCoOZVDGTml2qkE4rkEkVMqkhIFxjU0FMqohJDQDhrboVwKQKmNTsV4V0W8FLqnhJDf7gNtSgJVW0pAZ+cMtRsJIqVlLnuXEoUEkVKqnz3DsUpKSKlNSQD+4AClBSBUpqFolwE1CAkipQUrOBFRbJVHCSKk5S00lwz18FJ6niJDWdBPf8VWCSKkxSgz24X1AFJqnCJDWZBDf9VVCSKkpSt5Lgzw9IUgVJapgH7/upYCRVjKSGefC+nwpGUsVIapAH7/upQCRViKQmkfDsC4SkipDUFBKefYGQVBGSmkLCsxcAkipAUte5EWQFH6niI3Wdl6Ur8EgVHqn+YFkadKSKjlQ/94OpgCNVcKT6uR9MBRupYiPVj/1gKtBIFRqpWSTCk3+QkSoyUgM6DpN/gJEqMFLDOQ6Tf3CRKi5SgzkOk2dgkSosUv3BkxdUpIqKVM8nL67lgYpUUZF2Oz55G6BIExRpt+OTtwGJNCGRdsvkw07jDUykiYm0IA5uGN6ARJqQSAvhwEd/AxBpAiItfMN4y1UDEGkCIu12PNSigYc08ZB2LhZpoCFNNKQ9KBZpoCFNNKQ9KBZpgCFNMKQ9KBZpgCFNMKRlLyzDZeAGGtJEQ1p50NMbNKSJhrTyoK03aEgTDWnlQWdvwJAmGNJK5h8uYzfQkCYa0vL8C+4ODhrSRENaedDjGzCkCYa08qDNN1hIEwtp5UGnb6CQJhTS7LxrugGFNKGQZudd0w0kpImENDu3/G4AIU0gpNm563cDB2niIM3Ojb8bMEgTBml5NobR2lMDBWmiIM3O5680UJAmCtKyaoS3jDZwkCYO0tJBeMtoAwhpAiEtIYS3jDaQkCYS0rJwhLeMNqCQJhTSgjZ4q18DCmlCIS0phDeKNaCQJhTSkkJ4o1gDCmlCIS1kgzvUNJCQJhLS6rlQvQGENIGQVs+F6g0gpAmEtHouVG8AIU0gpNVzoXoDB2niIK0eC9UbKEjTIzXa2eIaHaqhp2qEafAcvtG5GnqwRpAGz+EbHa2hZ2uEaPAcvtHpGpfjNeIdhG+CeMCGpF+ABq/fNjpjQw/ZaOczghods6HnbCSAvH6B198/nbShR22041FBjc7a0MM20j+MFj8bHbch/tHSP4wWPxv4RxP/aOkfhvshGgBIEwBpCSCGC/gNBKSJgLQUkEoL8A0EpImAtBSQSgvwDQSkiYC0FJBKC/ANBKSJgLQUEN4w34BAmhBI2y2y+AkABNKEQFo2yeIN8w0MpImBtDSQikkIBtLEQFoaCO53b2AgTQykpYHgfvcGBtLEQFoaSKX3+AYE0oRAWhIIbldvICBNBKSlgPB29QYE0oRAWhIIbldvQCBNCKRl2chhHgUG0sRAWpaNcOVMAwRpgiAtEaSRwzZAkCYI0vahHY1/AshBUZCWB3e87peHqwgcpImDtDy8A/fLN4CQJhDS8vyOhhcBSEgTCWkzkxAvAqCQJhTS8hSPxjdiwJAmGNJmrgbiXoYGGtJEQ1roxmEmChrSREPazL0IeCcHDWmiIS10ww5zCeCQJhzSZnYL5Fs5eEgTD2krT4/BNzrwkCYe0lZ2LeI7OYBIExBpK2eDmMQAIk1ApAVwWMckBhBpAiItgMPwHIgGINIERNrKHMQ7OYBIExBp2TXrdac9pACISBMRaSEcPJ0DEGkCIi27ZvFG/QYi0kREWrbN4o3yDUikCYm0JJHBOQwm0sREWpoI75RvgCJNUKTt1lmcxKAiTVSkpYoMTGJgkSYs0vzYqLyBijRRkZYqMiZ0626gIk1UpG0VwWsAVKSJirRUEdxm30BFmqhISxXBPu8NVKSJirRUEdxl30BFmqhIz1oR3GXfgUW6sEi/Zc9Umkp0cJEuLtLTRSYmcAcX6eIi/Za92/BgPXCRLi7SAzr4BNgOMNIFRvrt2Cm/A4t0YZF+y83Rh3//moBdYKSHdLALdZCRLjLSb8fGqR1gpAuM9DwkhIsEOshIFxnp5dywvIOMdJGRnm20CIY6uEgXF+npIgg7HVyki4v0dBE84rWDi3RxkR7OwQdfdXCRLi7Sgzn4oNcOLNKFRfqDRlodWKQLi/RybpffgUW6sEgP5uBzVzuwSBcW6fuUEJoDdWCRLizSgzn4ZLoOLNKFRXowBx/01oFFurBIt3Pn3g4s0oVFejAHw2IHFunCIt0e5B+wSBcW6cEc7IIdWKQLi3Q7s1wHFunCIj2UgzdFdVCRLirSLZ+/9PzvgCJdUKTnYSF00kkHEulCIr0+uPuBiHQRkR7CgWeVdACRLiDSHxwW0sFDunhIf3BYSAcO6cIh/cFhIR04pAuH9AeHhXTgkC4c0uuD7AMO6cIhPTkE68s6cEgXDunBG5w9oCFdNKSnhix8gergIV08pIdv2EKW7wAiXUCkJ4gsnD4CiHQBkZ4gslDkOohIFxHpKSIL12M7kEgXEulJIouf4GAiXUykZ1HI6UeAJBQU6RtFDj8CZKGoSE8VOf0IkIbCIj3rQk4/AiSiwEhPGDn9CJCIehJ5yggW2XU6i1wPI08ZOXwFdB65HkjeHyUinUmuh5KnjJw+ASSiHkyeNIJ1fp2OJr+cTZ55iE8yPJ5c0jBpZOGSZKczyvWQ8qQRLvPrdE65HlSeNMJlfp3OKtfDypNGHNcUO51XLjbS00Yc6zM64EgXHOmJI1zo10FHuuhITx3hQr8OPNKFR3ryCPZm7cAjXXik5yEi/DsAHemiIz27avGMBnSki470cd6l3wFHuuBID+vgeukONtLFRvo4d/btYCNdbKSPc2ffDjTShUZ60gg2x+0gI11kpKeMHBZUgEa60EhPGsH2uh1opAuN9KQRxzkR0EgXGukhHXxGcAcZ6SIjPaCjYnvdDjDSBUZ6QAfPycBFurhITxc5LOgAjHSBkR7OgRt1O7BIFxbpoRwVa1Q7qEgXFemhHPxGASjSBUX6Oi/HAIl0IZG+HizHAIl0IZG+HrwOA4l0IZEexHF4oQES6UIiPYjj8EIDJNKFRHoIx+GFBkSki4j0PAodK3Q7kEgXEukhHBUrdDuISBcR6QEch+UkAJEuINLDNw7LCeAhXTykZwctvnsDh3ThkB66UW989wQO6cIhPXiDm4t34JAuHNI9l6P5+Q8g0gVEuuftjxdkQUS6iEhPETm8EwKJdCGR7pmD+AQDEulCIv18oEgHEekiIj2Eg++fACJdQGTkeSL0ww/wkCEeMm7nIrkBHjLEQ0bwBt4/B2jIEA0ZWSWC988BGjJEQ0ZqCN4/B2jIEA0ZwRt8/Q/gkCEcMvJMEbz+B2jIEA0Zt3ON5gANGaIh43au0RzAIUM4ZGSdCFbYD9CQIRoy8sx0/PEBQ4ZgyNhlIjj5GMAhQzhklGOB8AANGaIhoxwLhAdgyBAMGSW3p+K9a4CGDNGQUc4vHwM0ZIiGjNANvvoAQ4ZgyMhTRfjqAwwZgiEjcONw9QGGDMGQUc5P3wEYMgRDhp2fvgMwZAiGDDs/fQdgyBAMGVkjwlcfYMgQDBmJIXgywgAMGYIhI2tEsEpsAIYMwZARuMHvrgMwZAiGjAcYMgBDhmDIeIAhAzBkCIaMwI2K7TUGYMgQDBmhGxXbawzQkCEaMkI3ePY8QEOGaMgI3qjYnmMAhwzhkBG8wXdf0JAhGjLquURzgIYM0ZBRjyWaAzBkCIaM+qBEc4CGDNGQUc93P8CQIRgy6oO7H2DIEAwZ9cHdDzRkiIaM1BCukRygIUM0ZARuHG6fgCFDMGQEbhxun4AhQzBk7INF8PYJFjLEQkZaCNdIDrCQIRYy8mARvv8AhQyhkBGyUQu9PQ6QkCESMgI2Kp4rMgBChkDIaLkXhvYCDXCQIQ4yWt7/aO10AIMMYZDR8v5Hbz4DFGSIgoxQjYrNZQYoyBAFGT3vf/j8AwQZgiAjTKPiuR4DDGSIgYwgjWp4/wcCGUIgI0ij4rEcAwhkCIGMII2Kx3IMIJAhBDJCNKrh2/8AAhlCICNEoxomIAjIEAEZKSD4AAH/GOIfIzijYn3SAP4Ywh8jNKNifdIA/RiiHyMwoxrmL+DHEPwYI/MPCWoAfgzBjzHy9RcJaoB+DNGPEZpR+UiPAfwxhD9GcEblIz0G+McQ/xjhGZUrlAYAyBAAGSMfw3gTBQAZAiAjQKNygdIAARkiIGNkrwTMQhCQIQIyQjQqFigNEJAhAjICNCoWKA0AkCEAMmauQeNdFABkCICMmWvQeBcFABkCIGPmGgzeRQFAhgDISADB+qQBADIEQEaIRsXqoAECMkRARoBGbZiAACBDAGTMnAfiTRQEZIiAjBQQrA0aICBDBGSs7NWB+QcEMoRARtaFcIHZAAQZgiAjTxPh+q4BCjJEQUYWhnB51QAGGcIgY2UKYq/WAQ4yxEFGloZwfdMACBkCISNrQ7i+aYCEDJGQkRJy+gSQhkIhIynk9AkgD8VCRtgGV1gNsJAhFjLSQrDCaoCFDLGQEbZRO94HwEKGWMjI0hAusBpgIUMsZHjujcYbCVjIEAsZaSF8HMoACxliIWO3zOJHGVjIEAsZQRu1460IKGQIhYykkM4LmmAhQyxkeCYhdl0eoCFDNGQEb1Q+T2WAhwzxkHnLLMTraIKITBGRGcJRucprAolMIZEZxlG5TGsCikxBkZkoMuhCmIAiU1BkJorgcSYTUGQKisxEES7SmqAiU1RkpopwkdYEFpnCIjOLRLBIawKLTGGRGcxR8TSTCSwyhUVmsghWWU1gkSksMrN9FlZZTXCRKS4ygzkqVllNYJEpLDLDOfC9bAKLTGGRmUeJ/LnO/+gv36H9uZb/6KW9/O/y5/byiF9FQkJOCpXMrBvBhAAomQIlc5eN4CUBUDIFSmaWjUzcKDeBSqZQyUwqwdNVJlDJFCqZSSVY9jWBSqZQyUwqeaUm+gEgJcVKZloJFp5MsJIpVjItUxIvCbCSKVYywz4qbj2fYCVTrGSmlSy8JMBKpljJDPvgViwTrGSKlcy0Eqr7nEAlU6hkWtYt4WL7BCuZYiUz7KMuw88PCShWMtNKFi53T8CSKVgyE0sWascELZmiJTP0Y3VaLp6gJVO0ZKaWLPwNgpZM0ZKZxSNr4H8PGShcMpNL1qQJ8gQvmeIls55rlyaAyRQwmTU3Kyz8ASAHxUtmzRx0/O8hBQVMZoKJ3zADQEymiMlMMfGCHwBSUMRkBoBU5wcbiMkUMZkpJo5dASeQyRQymZtM+CIAM5liJjMMpHrnAJCFgiazZWPLwQEgCwVNZiBIdVTXCWoyRU1mqoljT/sJbDKFTWayiTsHgEQUN5nhIO3GiQhwMgVOZssqTr4bg5xMkZMZEtJueDcGOZkiJzMkpN2oMdwEOZkiJzMkpN0a0f8EOplCJzOPZL9xHoKdTLGTGRbSbpyHgCdT8GQGhrQb5yHoyRQ9maEh7Ybd2SbwyRQ+maEh7cZ5CHwyhU9mcEgrnIfgJ1P8ZAaItMJ5CIIyRVBmzy6r2KBwAqFMIZQZJNJe+8RCIoGhTDGUGSbSXvcwXTMZDGWKocyRXfY5EcFQphjKDBJphRMRDGWKocwgkVb4uQ6GMsVQZpBIe+2VSgEgEcVQZh4ywnNTIJQphDLHsa/MBEGZIigzBeUwNwVBmSIoMwWF56YgKFMEZaagHOamQChTCGUmoRzmpmAoUwxlhokc5qZgKFMMZaah8NwUDGWKocw0FJ6bgqFMMZSZh7Jzo9UJiDIFUWYiymFyC4oyRVFmqEjjVq0TGGUKo8xgEa6jmcAoUxhlbkah7TgTGGUKo8z1oLZ4gqNMcZQZLNJem83CVwiOMsVRZhaT8PsBMMoURplZTMLvB6AoUxRl5oEjxtNrUJQpijIDRdpru9tLMc4ERJmCKDNMpGHP6gmGMsVQ5socxEUWIJQphDJDRBruR5ggKFMEZe5qEnzBAkGZIihzV5PwfAIIZQqhTM8UxEUeIJQphDKznIRf0EBQpgjKTEE5vKABoUwhlJmEcnhBA0KZQigzy0kOL2hAKFMIZSahHF7QwFCmGMpMQzm8oIGhTDGUmYZyeEEDQ5liKDNIpOG2lgmEMoVQVhIKv+AtIJQlhLJumYZ4AusCQllCKCtEpGHb3gWCskRQVohIw7a9CwRliaCsWx69RMvNCwRliaCsFBR+w10gKEsEZQWItEqEswBQlgDKChBpL0/D6514AaAsAZR1yxdkvBMtEJQlgrJu+YKMc8oFhLKEUFaQSONtPQsMZYmhrJIHQNDNfIGhLDGUVfINmSa1CxBlCaKski/I9Iq/QEyWiMkqmYN0L19AJkvIZJV8PcYlggVmssRMVskcXJRDQCZLyGSVXKXBO+kCM1liJmv32sI76QI0WYImK88g4SWGBWiyBE1WHkJSnb4CQJMlaLLyEJJ2w/8eclDQZFnmIC5xLFCTJWqyLJOQb0TAJkvYZAWDND7HZYGbLHGTFRDSGhVoL4CTJXCywkFaoznlAjdZ4iYrHKQ1vBOCmyxxk2W5RMN3QnCTJW6yLJdoDt8gJKG4yQoHabi/bIGbLHGTlaeQNKTDBXCyBE5WQEhrfBmBnCyRkxUQ0hreSQBOlsDJylNIeJVrgZwskZNV8/UYV7kW0MkSOlk1s5D0cgGdLKGTFRLSOk5oQE6WyMkKCWm4t2qBnCyRkxUQ0nBv1QI4WQInKxykdbwKwU2WuMlq51XCBWyyhE1We7BKuIBNlrDJag9WCRewyRI2We3BKuECNlnCJqs9WCVcwCZL2GS18yrhAjVZoiarHVcJF5jJEjNZWWyCi3wLyGQJmawsNuFFvgVmssRMVj/78QIzWWImq5/9eAGZLCGT1c9+vEBMlojJ6g/8eIGYLBGT1c9+vABMloDJ6mc/XuAlS7xk9bMfL+CSJVyystoEVxcWaMkSLVmpJTwjByxZgiUrsYRn5GAlS6xkbSvBmxhQyRIqWZtKOAHASpZYydpWwrcQsJIlVrKy2RbfQoBKllDJGsfm5wugZAmUrDyJhHdGLoCSJVCyEkq4gf0CKVkiJWvkc5hWGBdQyRIqWXkSCTfAX0AlS6hk5VEkvLdygZUssZKV/bZ4b+UCK1liJSsbbnEOAJUsoZIV9ME5AFKyREpWyAfWLC+AkiVQsvIgEu4YsUBKlkjJymoTno0DlCyBkhXugS0jFjDJEiZZ89x/eoGSLFGSlYey85GAC5hkCZOsYI/DkYALnGSJk6x0Es4fYJIlTLJCPTh/AEmWIMlKJGGsXKAkS5RkbSXBpwgoyRIlWVlrcpjHgJIsUZK18jGMS9QLmGQJk6xgj8NECJhkCZOsLDXhiRAwyRImWVlpwhMhYJIlTLKy0ISxcoGTLHGSlU5ymEmBkyxxkpVOgnUSC5xkiZOscI/W8UisBVCyBEpWuMdBSxdAyRIoWX7uOrjASZY4yUonQS1dwCRLmGQ96rq1gEmWMMnytDrU0gVMsoRJVjIJz4ZBSZYoycpKE54Ng5IsURIP9DhoqYOSuCiJbyWhd2oHJHFBEs86E5yOOyCJC5J4lpmwNjooiYuSeNaZ4HzeQUlclMS3khy+wWsSuiiJ7+5bqIUOTOLCJJ51JqyFDk7i4iSehSashQ5O4uIknpUmrIUOTuLiJJ6lJqyFDk7i4iSetSasfQ5Q4gIlnkeSMHY5SImLlHhKCWKVg5S4SImnlDBWOVCJC5X4phKcUzhQiQuVeFIJnmzmQCUuVOKbSmhO4iAlLlLiW0rozdYBSlygxBNKOlbwOkCJC5R4Qgljk4OUuEiJp5Tg2WwOUuIiJZ5SgljlACUuUOIbSvhCBihxgRJPKGGscoASFyjxhBLGKgcpcZESTylBrHKQEhcp8S0lhFUOUuIiJZ5SwljlICUuUuIpJYxVDlLiIiW+pYSvY6ASFyrxTSWEVQ5S4iIlvqUEH+kAJS5Q4htK8E4IUOICJZ5QMogZHJzExUl8OwnfScFJXJzE00kYuxygxAVKPKGErclBSlykxFNKBkmJg5S4SImnlKBVOUiJi5R4SglblQOVuFCJbypBq3KwEhcr8bQStBoHKnGhEt9UQsucDlLiIiWeBSbYlswBSlygxBNKsPzZwUlcnMRb5iDfygFKXKDEs7yErciBSlyoxLO8hBd6HazExUo8y0t4odfBSlysxPt5kcbBSlysxPtxkcaBSlyoxPuDRRoHK3GxEu/nRRoHKnGhEu8PFmkcrMTFSrw/WKRxwBIXLPF+XqRxwBIXLPF+XqRxwBIXLPF+XqRxwBIXLPH+YJHGQUtctMTHg0UaBy5x4RLPs0m4EYMDl7hwiSeX8CKLA5e4cIkHf/AiiwOXuHCJj3N3agcvcfESTy/hRRYHL3HxEh+5oRoXWRy8xMVLPJtz4SKLg5e4eInv0hJaZHHgEhcu8ZFbWXmJALjEhUt85ioNPgxBS1y0xHdlCS6ygJa4aIlnc67DIgt4iYuXeFaW8CILgIkLmHhWlhwWWQBMXMDEE0wOiywgJi5i4llaclhkATNxMRPPBl2HRRZAExc08ezQdVhkATRxQRPP2pLDIgugiQuaeCBIYzd0UBMXNfEsLmE3dHATFzfxdJPDMg+4iYubeLrJYZkH4MQFTjzLS0bH2zHAiQuceJaX8DoRuImLm3iWlxzWiQBOXODEs75k4E46BzlxkRNfD+qOHejEhU58neuOHeTERU7cz3XHDnDiAifuD+qOHeTERU485WTgAcAOcuIiJ55ywgs9ACcucOKe6zR8MwE5cZET91yn4ZsJ0IkLnbhnGvLNBOjEhU486YQXekBOXOTEQ0IOCz0gJy5y4llfcljoATpxoZNySzvhlZ49+j7E/V++xci1GryW9uglRtEYuV5D6z178BLCNEQu2dAEYw9eQlQNkXus6b62By8hmoZ4sHCzRy8xusZ4sHazRy8xhsbI5Ru8Q+7RS4ypMTI98frYo5cYS2OcV3H24CWE5mh5sJCzRzVG0RwtD9Zy9uglhuZo1qGMxV8p+Mr9X77FiCTFJaE9eAmhSZrIgqtCe/ASQpM0mYUXZvboJYYmaUoLr83s0UsMTdLUFl6e2aOXGJqkKS68QrNHLzE0SVNdBrYq3KOXGJqldl7o2YMawjRJ7bjWs8cuETRF7cFyzx69xNAUtfOKzx68hNAUtQeLPnv0EkNz1B6s++zRSwzNUTsv/ezBSwhNUTuv/uzBSwjNUDsvAO3BSwhNUHuwBrRHLzE0QeuDZaA9qjGqZmh9sBK0Ry8xNEfrg8WgPXqJoTlaz+tBe/ASQnO0npeE9uAlhKZofbAqtEcvMTRF64OFoT16iaE5Ws9rQ3vwEkJztJ6Xh/bgJYTmaH2wQrRHLzE0R9t5kWgPaoimKZpqgx079+AlhGZous0kudqDlxCaoEk32CZzD15CaIJmncukyuM9eAmhCZqAg70y9+AlhOZnGg62y9yDlxCanqk4k+p/9+AlhKZnOg72zNyDlxCanu3cEmIPXkJodvYHXSH2qMbomp5Z+4KriHvwEkLTM02HFxL36CWG5meyDq8l7tFLDE3QpB1eTtyjlxiaoak7vKK4Ry8xNEWzexg2RN2DlxCaotk/DHui7sFLCE3R/mBpc49eYmiO9germ3v0EkOTdDxY4NyjGmNoko4Ha5x79BJDs3Q8WObco5cYmqXZUYzbV+zRSwzN0mwqhu1q9+AlhCbpeNBEYo9eYmiSJgDxmusevcTQLM2amcXPJUCg+798CxE3Uly53YOXEJqkKUG8eLtHLzE0SRODeP12j2qMqUkawNMWP2JBhO7/8i1EVvUfXpcAhe7/8i1G5OjixzS40P1fvoXIlVB+4wIZuv/LtxC5FkrLyXvwEkIzNLCnLZ4sgA7d/+VbiNw9iYvSe/QSQzM0xKctnnAAEd3/5VuIyNDFEw5Aovu/3CE2E+Hq+B7VGEsTNKUIF8j34CWEJuh60Bx0j15iaIKuB/1B9+glhmboetAidI9eYmiKbjSixfI9eAmhKZpuhOvle/ASQlM05YiXzPfoJYamaOLR4tko4NH9X76FyBTlOQv40f1f7hD+cOkeDOn+L99iPFy6B0a6/8u3GI+W7gGS7v/yLcSjpXuwpPu/fAvxaOkeNOn+L99CRIIungSCJ93/5VuISFDnyQaI0v1fvoWIBHV+yAMq3f/lW4gHnVL26CWGJqg/aJayRy8xJENL4pLjE7qQLRW1pXJ70DJlj15iFI3xoGvKHr3EMI0RGer4lC+ES0VxqSQuOdZ77tFLjKYxIkUdH46FcKkoLpXEJQaZQrZU1JZK2pLj87UQLRWlpZK0dDCdQrRUlJZK0tLBdArZUlFbKmlLB9MpZEtFbamkLbHpFKKlorRUkpbYdArJUlFZKilLjg+lQrJUVJZKypLjQ6mQLBWVpfJQlgrJUlFZKg9lqZAsFZWl8lCWCslSUVkqD2WpkCwVlaXyUJYKyVJRWSqPZKmQLBWVpfJAlgrJUlFZKlnW4/hwLARLRWGpBBO9ZB1/FyRLRWWpBBP1Gz5gC8FSUVgqoUTG/Qz36CWGpmgwUb/hQ7oQLBWFpRJM1G/8cCRYKgpLJZio3/ihRLBUFJZKKFG/4UtfIVcq6kolkKjf+JlErFSUlUoYUb/xA4VUqagqlSCifuPbH6FSUVQqiUo3vv0RKhVFpVIzPfkqIVQqikolhKgXznAypaKmVAKIeuHsJFIqSkolgKgXzk4ipaKkVAKIOp7pvgcvITQ7w4deDzzDpzORUlFSKgFEHY9234MaQkmpBBB1PN19D15CaHoGEHU84H0PXkJoegYQdTzjfQ9eQmh6BhB1POZ9D15CaHq24+lbe+wSQbMzD53BvjF78BJCszN8iFvH7MFLCM3O8CFHMi0ESkVBqSQo8R6HQqBUFJRKglLHRaZCnlTUk0p6Eq9TFfKkop5Udo0QlYntwUsIzc2wIW6mswcvITQ39yk0hx+EclMxqYQM2WtHHYxB2amYVBKT8OzdPXgJodkZNDQYPgphUlFMKiFD3fghQJZU1JJKwNDhQiVJKipJJVjo9RBdulAJkopCUgkVej1GF0NQdqojlUCh/vIyUF6+Cf1BiJGKMlIJEzps9SikSEUVqYxzx789eAmh2bkViRpu7cFLCE3OEKF+WMggQypqSCVPqDHs/LZHLzE0O4OEBp5NvAcvITQ7Q4S4/9wevITQ9AwQ6mY8OSBDKmpIJUTo4JyFDKmoIZU0pMMNgwipKCGV7MR2eCEhQipKSCVAaOBpz3vwEkLzM0CoG8/XiJCKElIJEDrd+YiQihJSmZmf/EJCglRUkEqeX8N3PgKkooBUgoNmwQUd8qOiflRWJufhd0p+VNSPSmjQxHX1QnxUlI9KlhodbnykR0X1qAQFvR7XS3dwwqOieFRCgiZvEylkR0XtqIQEzcNzhOyoqB2VkKCOR8rswUsIzc01H91xyI6K2lFJOzrcLsiOitpRCQnqdrjYCY+K4lHxzE9+mSA7KmpHJSCo22Fpi+yoqB2VkKDTDYPsqKgdlZCgjieU7MFLCE1QPzZT3WOXCJqfAUG9Hp5nZEdF7ahkIzc7LEUTHhXFoxIUhD0999glguZnQNBhy3QhOipKRyUcqOOZLXvwEkLS08KBOp66sgclhKkcWTAQv+AZuZGpG1m2deMXPCM2MmUjuz2YeRqxkSkbWRiQY6PdPXgJ0TREZic+U43UyFSNLAyoV1xFMVIjUzWyMCDnuZaRGpmqkWWTN35TNUIjUzSy3eYNLxEjMzI1Iyt57+SL3ciMTM3IQoDc8U3VyIxMzchCgDoeq7MHLyE0PUuuyB+Si9DIFI0sCKjj6Th78BJC87NkfuLDyMiMTM3ISuYnrmwZkZEpGVnJhsCnXyslqJKRhf8U4wVLIzIyJSML/ymGLU336CWGpmgAUHmdItDnIDMyNSMLAiqGrej26CWG5mgYUHld7KPvlNjIlI0s2ejwbDViI1M2skCgUg+JTm5k6kYWCFQq85WRG5m6kYUCnVaojODIFI4sGKjUQ46RHJnKkaUcNZw0GcmRqRxZOFA5MJoRHZnSkSUdNYQKIzoypSMLCCqVFyOM7MjUjiztqOGExciOTO3Isl8cL8Ma2ZGpHVnaUeM5D9mRqR1ZzRTlKbkRHpnikQUFlXa43EiPTPXIwoIOvdH36CWGpmjN/uqH/CI/MvUjq9lind+UjPzI1I8sNKi0xTEIkEwByRKQGk/ACJBMAckSkPDsqT14CaE5moDUeMJAgGQKSBYcVPrhfk6CZCpIFiBU+iHByJBMDclChEo/3M8JkUwRyYKESj/cz0mRTBXJAoVKP0xqyZFMHclChUo/JDpBkikkWbBQ6YdEJ0kylSQLFyr9kOhESaaUZAFDpR9uQGRJppZkaUnjkGOESaaYZD3vpTwpJUwyxSQLGeqNJ6VkSaaWZCFD5bDKbYRJpphkQUMdzzvbg5cQmqRBQ4XPatmjlxiapIFD5bBSbuRJpp5koUPlsM5tBEqmoGQblHjiQqBkCkoWPFQOfGEkSqaiZCNz9HCtECmZkpIFEJV5yHMyJVNTshCiMk9fKWWpopIlKuGJdnvwEkKTNFEJD7Xbg5cQmqQhRL3z7IdMydSULISozNMvlnJUUclCiMo83EgJlUxRyYKIyuSFPCNVMlUlCyMq65AcxEqmrGSBRGUdbj/kSqauZKFEZR3uHQRLprBkwURlHR60JEumsmThRGUd7j9ES6a0ZElLeOTUHryE0CxNWio8ryVbMrUly2N/1uHWQbpkqksWVFQW10Ua6ZKpLllgUfFDhpEvmfqShRYVP2QYAZMpMFlwUTmtC5IwmQqThRcVP9wGiZhMickCjIof7h5kTKbGZCFGxQ93D0ImU2SyEKPih/wgZDJFJgsyKn6YhpEymSqTBRnZ7ZQflKeqTJbKhKf77EENocpkQUb2ummYUp2UyVSZLMzIyiHFiJlMmcmSmQ72Z+RMps5kwUYH7TKCJlNosqxROjSCMYImU2iyUCPmLiNmMmUm82yKgwWrRs5k6kyWhwYdWgQZQZMpNFmw0cGqjKDJFJrqLZvi4N76StBUFZrqPj2I+9lUoqaq1FT3CULYIqgSNVWlphpw1Du+3VeipqrUVG8PWuJUoqaq1FRvj1riVLKmqtZUb49a4lTCpqrYVPM8oUOzo0raVFWbatjRYd9CJW2qqk017Ki/vpfDGnolbqrKTTW5iXsdVdKmqtpUS7414btsJW2qqk01zxbiDXCVtKmqNtWSjcWwx1AlbKqKTbVkYzFs4lIJm6piUy25DQ8bsFTCpqrYVLNA6dCWopI2VdWmWnIyiu/1lbCpKjbVkKOOZ4zswUsIzc+Ao45ndOzBSwhNz3CjjodE7EENodJUszpp4LtfJWiqCk3Vcpcozu0rOVNVZ6qBRn3gZKUSM1VlpprVSYPvwaRMVZWp5uFDB1appExVlanm+UPcT6ISMlVFpppHEHE/iUrGVNWYahrTwDW4SsZU1Zhqtr07dGGoZExVjammMR1qSCohU1VkqlmfNPj+ScZU1ZhqGtPg652Mqaox1axP4s5mlYypqjHVNCbubFbJmKoaU836JO5sVomYqhJTzfqkyQsClYipKjHVLFDi1maVhKmqMNUsUOLWZpWAqSow1ex5x3W7lXypqi/VrE/i7miVeKkqL9V9UNFhskO+VNWXava8OxS7VgKmqsBUE5i4S1slYKoKTDUrlLiXVyVfqupLNSuUJr/8VvKlqr5U2/kVqZIuVdWlmiVKh06slXSpqi7Vlu9IfB8nXKqKS3V3vePXrEq4VBWXalYpHTqxVsKlqrhUQ4oOr2qVbKmqLdVdpsSvakRLVWmp7sOM+DWLZKmqLNUsUzq8gFeipaq0VPeRRofrlWypqi3VrFM6vXWSLVW1pZq2dHizIFuqaks1u94dXhmJlqrSUg0nOr4yEi1VpaWaTe9Or4xES1VpqQYUnd5wiJaq0lLNnneHNxySpaqyVHfLO27uWEmWqspSzZZ33EW1EixVhaWaxUqHFy1ypaquVEeeNsNdaCrBUlVYqnnq0eFljWCpKizVPPjo0C2zkixVlaU6ctMod8usJEtVZanObB56uIuSLFWVpZpnIB26ZVaSpaqyVPc5SNxdo5IsVZWluo9C4kK0SrJUVZbqPg6JV0MryVJVWarzUWPGSrJUVZZqtr3jjoiVYKkqLNXd9u6Q6SRLVWWpzgcH0uzRSwxN03k+k2YPXkJolq7zsTR7UEMoLNX14GSaPXqJoUmafe+4dV4lV6rqSnW3vTtcK+RKVV2p7rZ3h2uFXKmqK9Vse3donVfJlaq6Us2+d9w6rxIrVWWlmn3vuHVeJVWqqkp1n5nErfMqqVJVVar72KTDFUuqVFWVaja+OzStq8RKVVmp7sZ3WFxXSZWqqlLdfe/4KUuoVBWV6u57x/ceMqWqplSz792h11slVKqKSnWj0ukLpRRVVKrZ+e7QZK0SK1VlpZqt77g1WSVWqspK1R/1FavESlVZqfqjvmKVXKmqK7Vsfcc9wRq5UlNXaulKvLbQiJWaslLLzneHblyNXKmpK7XsfHfoxtUIlprCUsvWd4cFikay1FSW2j5YiRcoGslSU1lqWcV02FXTSJaaylILJuKlgUau1NSV2q5i4sutESw1haWWZUy8NNDIlZq6UktX4m7SjVypqSu1UKLT6kIjWGoKSy1h6bC60EiWmspSCyc6rC40kqWmstS2LOHqQiNZaipLLWWJVxcayVJTWWq79R2vLjSSpaay1Moj+mxES01pqSUtcW/tRrTUlJZadr47LFA0sqWmttTsAX02sqWmttRCig4LFI1sqakttZCi0wJFI1xqikvN8rWeFyga6VJTXWr2oAdJI11qqkttH6qECxSNcKkpLrVsfcf9zhvhUlNcatn6jjuNN8KlprjUgopOyySNdKmpLrXUJV4maYRLTXGp7TOVcJmkkS01taVW852eJ3CNcKkpLrWa7/S4TNIIl5riUqv5Sn/4QkmXmupSyyOVDsskjXipKS+1mq/0h8cB+VJTX2o1V54O0x7ypaa+1PJMpcMySSNgagpMLQ9VOiyTNBKmpsLUai498TJJI2JqSkwtiYlb6jcipqbE1FpmKb+3NSKmpsTUkph4paWRMDUVppbHKh1WWhoRU1Nianmu0mGlpZExNTWmlgcr8UpLI2JqSkwtD1bilZZGxtTUmFp7dNxCI2NqakwtT1bilZZGxtTUmFrLd/rD5UbG1NSYWs91p8PlRsbU1Jhaz4Wnw+VGyNQUmVrPHMWVlkbI1BSZWs+XelxpaYRMTZGp7V54vNLSCJmaIlPrmaKHK5aQqSkytUSmw0pLI2Rqikwtj1bilZZGyNQUmVqQ0WGlpREyNUWmFmJ0WGlpZExNjamlMR1WWhoZU1Njanmw0mGlpREyNUWmNh61s2+kTE2VqaUy8UpLI2Rqikwtkemw0tJImZoqUxv5Ts8rLY2YqSkztTxY6bDSQsrUVJlanqt0WGkhZWqqTC3PVTqttJAyNVWmlgcrnVZaSJmaKlPLg5VOKy2kTE2VqeXBSqeVFlKmpsrUgow6H8HTCJmaIlMLMTostBAxNSWmlsR0WCQhYWoqTC2F6bTCQcLUVJhaeNFpdYKEqakwtZnv9Lw6QcDUFJjazFUnXp0gX2rqS23motMpuShBFZhacNHpJZaAqSkwtZWrTvwSS77U1JdaNsY7vLeRLzX1pbbyhYnfuYiXmvJSWw/O/WqkS011qa0H5341wqWmuNQSlw53P8KlprjU1qPTFhrpUlNdauvRaQuNdKmpLrXsjMcHMzXCpaa41LJk6VCe1wiXmuJSS1zq3DmnkS411aWWunSa2xMvNeWlljVLfKBRI15qykvN8xaKHbca6VJTXWrZG4/PRGqES01xqWXFEncibmRLTW2pee514tVusqWmttQ8S5QPn4ISVGmpZWs8bmbcSJaaylLPiiVe0OwkS11lqYcTdT6XqZMsdZWlngVL3EatEyx1haWeBUs8je3kSl1dqQcSdT6VqRMrdWWlnr3xHNciO6lSV1XqqUp8KFMnVOqKSj1RiU9U6qRKXVWpBxF1Pv+nEyp1RaUeRGRj0lS6Eyp1RaVeHu2276RKXVWpZ7USXySdUKkrKvXsjccnGXUypa6m1EOI+qGGthMqdUWlHkR0aqHWSZW6qlIPIxp84k0nVeqqSj2IaPBpNZ1QqSsq9RCiwafVdDKlrqbUQ4gGn1bTyZS6mlIPIBp8Wk0nUupKSj2AaPBpNZ1IqSsp9QCi01G+nUypqyn1AKLBJ950IqWupNTDhwafeNNJlLqKUg8fGnziTSdR6ipK3TI9cY7RSZS6ilIPHxp84k0nUeoqSj18aPCJN51Eqaso9RSlw7JKJ1HqKkrdsqs9d8voREpdSakHEA0+NqcTKXUlpR4+NApfJiRKXUWphw8NPjWnkyh1FaUePDT41JxOoNQVlHrNjcyspp1AqSso9dChwSfvdPKkrp7UayYoXybESV05qddMUL5MSJO6alIPGhp8JkgnTOqKST1kaLy2OKWnM2FSV0zqQUP2uoeGYpAmddWkHjT0MnvFH4UwqSsm9aCh449CmtRVk3rLchB8uemESV0xqYcMDT40oZMldbWkHjI0jLtTdMKkrpjU80ylw0sBYVJXTOohQ6ddDp0wqSsm9cSk0/VKmtRVk3rLHOU7D2FSV0zqIUODW/13sqSultR7ZijfNYiSulJS75mhfNcgSupKST1gaBjfNYiSulJSDxca3B6/kyR1laQeLDQqP1wJkrpCUg8VGtwSvpMjdXWk3ueDi5Ucqasj9TxV6dCNoRMkdYWkvquVDq8FJEldJakHC9mh9VInSeoqST1YyA6tlzpJUldJ6sFC5tzTppMkdZWkHi5kzv15OlFSV0rq4UJ2aAHViZK6UlIPF7JDC6hOlNSVkvrILOWbOVFSV0rqAUODW+13oqSulNTzdCVutd9JkrpKUs/Tlbg1fCdI6gpJPVRocFv3To7U1ZF6Hq7Ebd07MVJXRuqBQoPbundipK6M1PNwJW513cmRujpSz8OVuE11J0fq6kg9UGhwi+lOjNSVkXoersT9oTsxUldG6oFCg/sQd2KkrozUA4UG9yHuxEhdGamHCQ3uQ9xJkboqUg8TGtzftZMidVWkvvLoL85OUqSuitTDhAb3Zu2kSF0Vqa88+ouzkxSpqyL1MKHB/Ts7KVJXRephQoP7d3ZSpK6K1MOEBvfv7KRIXRWpBwmNQzPlTorUVZH6ypekUwzKT1Wknp3vDg32OzFSV0bqYUKDO991UqSuitSDhAY39OqESF0RqefxSp0vEzKkrobUPROULxMypK6G1LPt3aEpdCdE6opI3R85fCdF6qpIPUxocL+kTorUVZF6ViidXnCIkboyUg8UGtxzqRMjdWWkHig0uOdSJ0bqykgjUGgM7sEyyJGGOtIIFRrcdGmQIw11pBEqNLjp0iBHGupII1TodLkOgqShkDSChQY3bhoESUMhadweZeggSRoqSeOWGYrX6yBJGipJI1xoHDpTD6KkoZQ0bpmh+FwbRElDKWkEDA3uVTSIkoZS0ggXGtyraJAkDZWkES40uFfRIEkaKkkjXGgcehUNoqShlDTChQb3KhokSUMlaQQLDe5VNAiShkLSSEjiRkODIGkoJI2EJG7wMwiShkLSSEiah/wkSRoqSSMlaXJ+kiQNlaSRkrQ4P0mShkrSSEni+rlBkjRUkkaw0Dh01x4kSUMlaaQkcT3OIEkaKkkjJYnrcQZJ0lBJGilJXGIwSJKGStJISeItg4MkaagkjZQk3v8zSJKGStJISVo43xkkSUMlaQQLjcMS0SBJGipJIyXpsEQ0SJKGStJISTosEQ2ipKGUNJKSeKvIIEoaSkkjKYk3aQyipKGUNJKSeJPGIEoaSkkjKemw1XgQJQ2lpJGUdFhjGmRJQy1ppCUd2owPwqShmDQSkw5txgdp0lBNGqlJhzbjgzhpKCeN5CTn+zBp0lBNGkFD89BlfJAmDdWkkbVJk5cgB3HSUE4aYUPzdrhWiJOGctIIHJq3w92cPGmoJ43QoXk7TDcIlIaC0ggdmjd+Bx4ESkNBaQQPzdsh1UmUhorSCB6at0OqkygNFaURPDRvh1QnURoqSiN8aN74PI5BpDSUlEbPPD3c08mUhprSCCGa5ZDrhEpDUWkEEc1yyFNSpaGqNLIL3us5KfR9ECsNZaWRFUqHPTCDXGmoK41QolmYHwbB0lBYGsFEhtufB7nSUFcaoUSzHK44gqWhsDRCiebhgIFBsDQUlkYo0SyHK45gaSgsjVCiWQ5XHMHSUFgaI7OUjw4dBEtDYWmMzNLDw4VgaSgsjVCiWQ5XHMHSUFgaoUTTDlccwdJQWBqhRPNwLOwgWBoKSyOYaB4OjxgkS0NlaYQTTTvkKdHSUFoaAUXzsDo6yJaG2tIIKZrs84NsaagtjZCiQ0HMIFsaaksjpOiwVXWQLQ21pRFSNO1wGyRcGopLI6ho2uHxRLo0VJfGzCQ9XCzES0N5aQQWnSoOBvnSUF8aM5P0cMERMA0FphFcNA/n/Q4SpqHCNHahEheTDCKmocQ0Aowmb1kYRExDiWkEGM3DkcGDjGmoMY1dqYR7FgYZ01BjGtkJr/Np0IOQaSgyjSCjya49CJmGItNYj9bwBynTUGUaYUbztFBLzDSUmUag0Xxtj48xKEnVmcbKJD1c+ORMQ51pBBpN5vFBzDSUmcbKHOWVBlKmoco0PHOUX8BImYYq00hlOq0XEzMNZaYRaDSZ2Acx01BmGoFGk4l9EDMNZaYRZjSZ2Acp01BlGp5LpIdnLCnTUGUaYUaTmX6QMg1VphFkNJnpByHTUGQanmfX8FOakGkoMo1EptNKLSnTUGWaQUaTqX8SMk1FphlkNJn6JyHTVGSat8xPvNImIdNUZJq3zE+80iYZ01RjmiFGk6l/kjFNNaYZYDSZ+icR01RimklMhyXnScY01ZhmgNHk7QKTiGkqMc08W4m3C0wipqnENAOMJh/nOImYphLTDDCarPSTiGkqMc0Ao8lKP4mYphLTDC+arPSThGmqMM3woslKP0mYpgrTLJmenOEkTFOFaYYXTQb2ScI0VZhmeNHp7NRJxDSVmGYS02H9fRIxTSWmmcR0WH+fZExTjWmWR6fXTEKmqcg0g4wmbxaYhExTkWmGGE3eLDDJmKYa0wwxmnxA0yRjmmpMM43pgBGTkGkqMk3LNyV655tkTFONaVpmKN8zyJimGtMMMTqdvToJmaYi0wwymrzrYRIyTUWmGWI0ecfCJGOaakwzwGjyboNJxDSVmGbN9OT7DgnTVGGaNdOT7zskTFOFaYYXTd5sMEmYpgrTDC+avNlgkjBNFaaZZysd3p8nCdNUYZrBRZM3LEwCpqnANGv2FePeUZOAaSowzdCiOfl6J1+a6kszsGjynodJvDSVl2Zg0eQ9D5N4aSovzeQl3vMwSZem6tLchytxn6NJujRVl2bqEu+bmIRLU3FpJi7xwUiTbGmqLc20Jd42MYmWptLSbI8aNk2ipam0NJOWeOvFJFmaKkszZemwnjpJlqbK0kxZ4u0bk2BpKizNhCXukjvJlaa60kxX4t0bk1hpKivNLFU6FJ1OYqWprDSTlXgHyCRVmqpKM4ho8g6QSag0FZVm1iodfH0SKk1FpZmoxLtIJpnSVFOaPROUr1ZCpamoNBOVeBfJJFOaakozgOh08PUkU5pqSrMn0LMHTTKlqaY005S4icwkUppKSjNJiTvATBKlqaI0U5S4fcskUJoKSnPkDJTX6ieB0lRQmglKvB1mkidN9aSZnsTbYSZx0lROmlmndNi7MYmTpnLSTE7iLTWTNGmqJs3UJO57MgmTpmLSTEzivieTMGkqJs2gocl9TyZh0lRMmjPzk69WwqSpmDQTk3grzCRLmmpJM2BocaOPSZQ0lZJmuNDiRh+TJGmqJM1gocWNPiZB0lRImtnvjht9THKkqY40A4UWN/qYxEhTGWmGCa3DDpZJjDSVkWag0OIuHZMYaSojzTChxV06JinSVEWaYUKLu3RMUqSpijSDhNbt8NJKijRVkWaY0OI2HZMUaaoizSChxW06JiHSVESa65F0TkKkqYg0Q4RW4RwnQ5pqSDNAaHGXjkmENJWQZoDQ4i4dkwhpKiHNAKHFXTomEdJUQpoBQou7dEwipKmENMODFnfYmCRIUwVppiAdtgFOIqSphDQ985MvEyKkqYQ0PfOT7+JESFMJaYYHLe7SMUmQpgrSDA9axlcJCdJUQZrhQYsbbEwSpKmCNMODFne2mCRIUwVpBgctY/CdJEhTBWmFBy3ebrJIkJYK0goPWtwOYpEgLRWkdXuk8IsIaSkhrSSkA38vMqSlhrTSkA78vQiRliLSSkQ68PciRVqqSCtI6LTldpEiLVWklYp02HK7iJGWMtJKRjpsuV3kSEsdaaUjHbbcLoKkpZC0EpIOW24XSdJSSVopSYcJyyJKWkpJKynpsOV2kSUttaSVlnTYcrsIk5Zi0kpMOmy5XaRJSzVppSYdttwu4qSlnLTChk5bbhdx0lJOWiU3iB7ylDhpKSetsKHTlttFnLSUk9bmJN5yu4iTlnLSSk46bLld5ElLPWmFDvGW20WctJSTVnLSYcvtIk9a6knLcnvo4YojT1rqSSs96bDldpEoLRWllaJ02HK7iJSWktKyzFLecruIlJaS0kpSOmy5XWRKS01ppSkdttwuQqWlqLQSlQ5bbhep0lJVWqlKhy23i1hpKSutZKXDEvEiV1rqSitd6bDldhEsLYWllbB02HK7SJaWytIKJlrcjGoRLC2FpZXHKt3wrWkRLC2FpZWnKvHRFYtcaakrrVCihft+F7HSUlZaeaQSF1kvYqWlrLTyRKXOUzlipaWstAKJKsP+IlZaykqrPdgaukiVlqrSCiN6uZe/hCh++RSUnapKa5+ndPhBKDlVlVbL5MTXrkWqtFSVVhDRob33IlRaikoriOjQm3sRKi1FpRVCdGg7vMiUlprSCiE6tOFbZEpLTWmFEB3OR1hkSktNaYUQHXpzLzKlpaa0AogOvbkXkdJSUloBRIt71y0ipaWktJKUCu33WCRKS0Vp9TT5wxOeRGmpKK3wodfjEeiuRaK0VJRWihJuXFkESktBaWX3u0NmESgtBaWVRUqVLxHypKWetLJGic/mW8RJSzlpJScdLlTipKWctEauh/Ji5iJPWupJK3RocVvERZ601JNW4NDiGoNFnLSUk1bg0OK2iIs4aSknrcChxXv7F3HSUk5aYUOLe9Yt0qSlmrTChhb3rFukSUs1aYUNLe5Zt0iTlmrSChtavCl/kSYt1aSVpUm8KX+RJi3VpBU29DJn4HsOcdJSTlqBQ4t31C/ipKWctLLvHT8ESJOWatIKG3J+EhEmLcWklacnHWZrhElLMWnNB51tF2HSUkxa80Hn0EWYtBSTVtYkHR6pZElLLWmlJXGFwyJLWmpJK2So18N7EWHSUkxaQUNmh5UZ0qSlmrRSk7jSYhEmLcWkFTRkh81yizRpqSatsCGrh9cz4qSlnLTChhZXayzSpKWatMKGrDWeRBMnLeWkFThk7bCuS5601JNW6FA5rS8TKC0FpRU81BxL7xaB0lJQWnmA0qEkcpEoLRWlFT5k/fDyTqS0lJSWZ5LyU41EaakorRQlLqJZJEpLRWmlKJ0WdYmUlpLSSlI6zXfIlJaa0tqmdEgOQqWlqLQSlbiYZxEqLUWllUcoHd6xCJWWotJKVOJ6oEWmtNSUPE2J64GcTMnVlDxNieuBnEzJ1ZQ8gOh00piTKbmakgcQLa4pciIlV1LyWx5CxweNOZGSKyl5+NDiuiQnUXIVJc9DlDgznEDJFZT89qiDvRMouYKShw4tLm1y8iRXT/LAocWlTU6c5MpJXrJAnhcNnTjJlZM8bOhQZO+kSa6a5EFDhyJ7J0xyxSRPTDoU2TthkismeWLS4YnihEmumOQhQyc8ccIkV0zyxKRDob4TJrlikocMLa44c7IkV0vygKHTDhgnS3K1JC+Zo3grd6IkV0rypKTDDM6JklwpybM06dAuwAmTXDHJQ4YWV885WZKrJbnlXfTwiyVLcrUkT0s6tAtwsiRXS3LLFqL4ouJESa6U5OFCp40KTpTkSkkeLnR42XGSJFdJ8pSkw1zUSZJcJclTkg57HZwkyVWSPCXpsNfBSZJcJclr3kj5UU+Q5ApJHiq0uDDSyZFcHckDhRYXAjoxkisjeTISFwI6MZIrI3mg0OJCQCdGcmUkz/oku/GdmBzJ1ZG8PnzSkyS5SpLXR2fVOFGSKyV5wNDpQBEnS3K1JA8ZWlyS6GRJrpbkIUOTp05ESa6U5AFDDHNOkuQqSR4uVA6/EZIkV0nycKGDZzlJkqskeUvmPEyciJJcKckDhl7PfaQ7KFGSKyV5wFA9vPU5WZKrJXla0mErjxMmuWKSBw0trjN1wiRXTPJ+e3SpkSa5apKHDS2uVXXSJFdN8rChVpzvGsRJrpzkoUPnH4VyVEHJe95DebZBnuTqSd7zZemQowRKrqDkG5QOzzUiJVdS8gCi45SYTMnVlLyvRzMnQiVXVPKeScpv44RKrqjkIw/84sPgnFTJVZU8VYnrkJ1QyRWVPM9TOhyN56RKrqrkqUpcy+ykSq6q5GFEp2kkqZKrKnmqEpdDO6mSqyp5qhKXMjupkqsqeaoSlyE7qZKrKnmqEpchO6mSqyp5qhKXITupkqsqeaoSlyE7qZKrKnkQ0XGqQarkqkqeqsRlyE6q5KpKnkVKXIbsxEqurORZpMRlyE6u5OpKnkVKXELs5EquruRZpMTlv06u5OpKnkVKhzVVJ1hyhSXPKiUuIXaCJVdY8oQlLiF2giVXWPIsUuLyXydXcnUlzyIlLv91YiVXVvJkJS7ddWIlV1byZKXDihWpkqsqedYocfWvEyq5opInKnH1rxMquaKSZ4kSV906mZKrKXmWKHHVrRMpuZKSZ5e7wzZuJ1JyJSXPGiWu3HUiJVdS8qxR4qpbJ1FyFSUPHjpOdkiUXEXJw4faOEy6iJRcScmTlLj614mUXEnJk5S4ctdJlFxFyVOUuHLXCZRcQckTlA6l5U6g5ApKnqDEpbtOoOQKSh48dLrgCZRcQcmDh07yQKDkAkp2S1DCAuI9+D7E/V++hYjnu+Ny6h69xCgaI26gWIS8By8hTEO8ZptjEfIevISoGqKdM2OPXmI0jdHjY9BNYw9eQnQNEa/xWMi8By8hhoaYEYIu1j14CTE1RG6px639e/QSY2kMj49BF/wevITQBA0d8htd8HtQQxRN0PJgW9MevcTQBA0eOkxi9+glhmZo8BDvZN+DlxCaoaFDjmXde/ASQhO0ZILSrWsPXkJogpZMUHx33qOXGJqhJTOUr3jgpPu/fAvxmm6OZd178BJCEzRsyLGsew9eQmiCBg05lmTvQQ1hmqAhQ44l2XvwEkLzM2TIsSR7D15CaHoGDDmWZO/BSwhNz3Ahx5LsPXgJoekZLuRYkr0HLyE0PYOFHMup9+AlhGZnsJBxBd8evcTQ9LRMT85wgKT7v3wLEVvquQRnj15iaH6GCjmWde9BDVE1P0OFHMu69+AlhOZnqJAbIuMevcTQBA0Wcqzr3oOXEJqgwUJ++kJBku7/8i1GZCjWde/BSwjN0GAhx7ruPXgJoRkaKuRYWbUHLyE0QQOFHOtf9uAlhCZomJBjqcQevITQ/AwTctzPvgc1RNP8DBSyP9fyH/3lDljH7c+1/8drlabX8uf28rRdReNS0jZN2qAiZxnfo5cYmrRhRY673PfgJYQmbViR4y73PXgJoTkbVOS4y30PXkJoziYu4S73PXgJoTkbUuS4y30PXkJozgYUOe5y34OXEJqzAUWOref34CWE5mw4keMm9z2oIbrmbDiR46bqPXgJoekZTOS4mXkPXkJodoYSOW4i3oOXEJqdoUSOu1X34CWEZmcgkeNu1T14CaHZGUbkuMNzD15CaHYGETluz9yDlxCanSFEjtsz9+AlhGZnCJHj9sw9eAmh2RlA5Li1cg9qiKHZGUDkuC1yD15CaHaGDznuR9yDlxCaneFDjvsR9+AlhGZn+JBjq/U9eAmh2Rk+5LjxbQ9eQmh2hg85blrbg5cQmp3hQ46bxfbgJYRmZ/iQY6v1PXgJodkZPuS4o2gPXkJodoYPOe4o2oMaYmp2Bg857ijag5cQmp3BQ447ivbgJYRmZ/CQ446iPXgJodmZdUq4g2YPXkJodgYPOW6U2IOXEJqdwUOOmxz24CWEZmfokOPmgj14CaHZGTrkiOl78BJCszN0yBHC9+AlhGbnetBmZI9qjKXpGTzkCOF78BJC0zN4yFGx9+AlhKZn8JCjYu/BSwhNz+AhR8Xeg5cQmp7BQ46KvQcvITQ9g4ccFXsPXkJoegYPOSr2HryE0PQMHXIU6D14CaHpGTrkKNB78BJC0zN0yFGg96CGcM3OwCFHgd6DlxCanWFDjgK9By8hNDvDhhz1eA9eQmh2hg056vEevITQ7AwbctTjPXgJodkZNOSox3vwEkKzM2jIUY/34CWEZmfQkCP97sFLCM3OoCHnop49eokh6VnChhztdw9KiKKaVIKGnI8v2aOXGEVjRH4i3O7BSwjTEJGfCLd78BKiaojITwTTPXgJ0TRE5CeC6R68hOgaIveEYn4WwqSimFQSk7DV8R68hJgaIvITvXQPXkIsDRH5yVJZyJKKWlJJS2JlLGRJRS2pBAy9ZC3ePgtZUlFLKgFDLzE4P8mSilpSCRl6icFrU4U0qagmlbChlyCcosRJRTmpBA69xOAcJU8q6kklj0668a7jPXwJolkaPPQShNOURKmoKJXwoZcYnKdESkVJqQQQvcTgRCVTKmpKJYToJQZnKqFSUVQqlpnKPFZIlYqqUrHMVPaxQqxUlJWKZaYykBVypaKuVCwTlYWsECwVhaVimahMZIVkqagslaxRGriraI9eYmieWuYpO1shWipKS8UyTxnaCtlSUVsqlnnK0lbIloraUqmZp0xthXCpKC6VuvOUc510qagulZp5yr379vAliCZqzURl5irkS0V9qdRM1INzFQKmosBUamYqQ1chYSoqTKXmLdU424mYihJTqZmpLF2FjKmoMZWamcrUVQiZiiJTqZmpXEa7hy9BNFVbpiprVyFnKupMpWWqMncVMqWiplSy9d2NvauQKRU1pZIVSzds4LRHLzE0U7Nk6XbArUKsVJSVSstMZd0q5EpFXam0zFTmrUKwVBSWSstMZd8qJEtFZam0zFQGrkK0VJSWSstMZeEqZEtFban0TFQmrkK4VBSXSs9EZeMqpEtFdan0TFRGrkK8VJSXSs9EZeUq5EtFfan0TFRmrkLAVBSYSjbCu7FzFRKmosJUeuYpQ1chYipKTKVnnrJ0FTKmosZUeuYpU1chZCqKTCVPV+JCrj16iaF5OjJP2csKMVNRZioj85TBrJAzFXWmEmrUXp640Npvj15iaJ6Onad8vZA0FZWmMjJPmd0KUVNRaipJTafZA1lTUWsqaU2HLS6FsKkoNpWRecr+V0ibimpTGZmnDICFuKkoN5WR91MWwELeVNSbSnrT6TlH4FQUnMrMPGVGLCRORcWpzLyfsiMWIqei5FRm5ilDYiFzKmpOZe485euW0KkoOpWZ91OmxELqVFSdysz7KVtiIXYqyk5lZp4yJhZyp6LuVGbmKWtiIXgqCk9lZp4yJxaSp6LyVFbeT9kTC8lTUXkqKU+HNdxC9FSUnsrKPGWULGRPRe2prMxTVslC+FQUn0pQUmvYtXuPXmJonq7MU6bNQvxUlJ/Kyjxl2yzkT0X9qaQ/nRa1CaCKAlRZO0/5miOBKipQJQXqsHG7EEEVJajiO0/5uiWDKmpQxfN+ykRaCKGKIlTxzFM20kIKVVShSphSc6yD3KOXGJqnvhdRD4uXBFFFIap4JiprbSGJKipRxTNRmWsLUVRRiiqeN1T22kIWVdSiimeiMtgWwqiiGFU8b6gstoUwqihG2S0TlcnWSKNMNcpu+42fr1wjjjLlKLvtTMUr18ijTD3KbnlHZfk1AilTkLJbZirTr5FImYqU3TJR2X6NSMqUpOyWicr4a2RSpiZlt0xU1l8jlDJFKbtlojL/GqmUqUrZLROV/deIpUxZykomKgOwkUuZupRtl2IBNnIpU5ey7VJY/btHLzE0T7dLMQEbsZQpS1kYkznvwTFiKVOWsjAmczzma49eYmiebpbCOuQ9eomhebpVii3aSKVMVcq2SjFGG6mUqUrZVinWaCOVMlUpC2Li92wjkzI1KQtgGgP7Hu/RSwzN0m1SjOJGJmVqUrZNilXcyKRMTcq2STGLG5mUqUnZNil2cSOTMjUpC2Cq3M1wj15iaJZm3zzuZrhHLzE0S7dJMdAbmZSpSdk2KRZ6I5MyNSlLkyos9EYmZWpSFsBUG8+TjUzK1KQsfKn2w3dKJGVKUha+VA/rdEYkZUpSFrxUOxc1G4mUqUhZnsHUGWCMRMpUpCwPYeKGS3v0EkPzNHip9kOuk0iZipTtc5iwFf0evcTQPM2DmA5rSkYgZQpSFrrU5+FnIZAyBSnLo5i4j/wevcTQPE2QKrwbxQikTEHKdgs9Llk3AilTkLINUocdLUYgZQpSll30xuGXSyBlClKWBzKtw4VLIGUKUpYgVXhnjRFImYKUbZA6rAYbiZSpSFmKVOHtOUYiZSpStkXq4K9GJGVKUpYkVbiQ34ikTEnKNkmdrjsyKVOTsgCmWvl13cikTE3KAphamdSBc49eYmiqBjC1sg4xKFXVpCxNqvCeJyOTMjUp6ztVeQ5CJmVqUpYmVXjPk5FJmZqU9Z2p/OwnkzI1KUuTKrznycikTE3K0qQK73kyMilTk7KR91Te82RkUqYmZWlShfc8GZmUqUlZmlThPU9GJmVqUhbA9BKDL1wyKVOTspF5yvuVjEzK1KQsTarwfiUjkzI1KUuTKrxfycikTE3KAphqOzy3yaRMTcrmzlPOdTIpU5OyACY+8GQPXkJomiZJFe4NYERSpiRl4UuHA0/26CWGpmn40mvZNsegNFWSsiSpwru3jEjKlKQsSarg4fN79BJD0zR86bSkbERSpiRlSVKFN4AZkZQpSVmSVOENYEYkZUpSliRVeAOYEUmZkpSFL9VxeIUhkjIlKQtfquPwyCaSMiUpC1/q8zBVJpIyJSnLY5t4AYRA6u0v/+8//+nTz//8+PXbx5/+r59/+vjvP/3n//pff/rLX/7r84dv3z7++9uPH37828c//fl//vSXTzm62p/jn/zTf/7Pn17X1//zf/73//7z27/1+r/+/P0fibHXf/Uvf/nrx2+ffv7bx6+fvn344fPHl9BfP/3w27ePv95H7nXchX5dvnsu9i9fP/3zw7d3H7LaXajx8ih+LtI/P3z+9NNLqG///cvH+K/vQr4+ML+HfH3LiCDldYXwqeCvP/O7H/e1Q9vdN/nsV/nj3z59/unrx5/ffXN+/83125OhXn4pP375+dvr393/oP0uVs3/tr/9uLfb/sPLW0X+4eWCiD+8vjTFH+rq+YdmT/4Gf/7y7eOnn979/lb5/UNM2//WfHnexR9eDz6LP/jvH8ze/lTbfPuMt/XcB/jly6+fvn368vP7j2D3H2G+fQTfH6F9/yz17bPU75/l7U/m8/unWt8/lb/96eVB8dTn+5V/Ufe/9LZ/Ud8/Q/n+j7z9ouztF9XeflHj7Rf1XA5/+OHXb18//Pjth48//vjhZeDTt/++/zx3N4bnfvEvoeRLfz236e5n8rdsez2i6dmIl3vBy331919kecvb0d6+oXUbfyj4Xz78/NNfPv77l5f/8/7faff/znPX4PeYP/3w+cfPn378+w786/vI/T7yc0n9FvnvH9/9ksa4v+uMP/ij//zxX68X6/v74u0uYrx//aGI13DrXbg/8NO+f071dw+q8j2Vev8DEeOye3kK/u3Dz3/9+O7X/bqr7/dfytrXlL/dIP3tRvG60/XtHjDers5m+24Q+/3+v36cj/+UO8LLhXz/mfrbZ9qZ/tr+en+mdvv+mdr3z/TcYzI/yevvDb6V2Kf4+6+vjCfvLBHz1x+/fvz4M0btt3dRn7tvZtR/fvr108uc4z7e9Ptn3H6s/J/D/fQyN/j2Mh96/duvX/717pv3ux/7dZb+ByLmVOj9RVDv5xr79/g66X427A9fP7x8ke9urbfbu0/45Ff4Euq3b99e0u7Lty9fPv/w4atcrP7uYn0yg376KWYx7yd/893k7+mPR/Oh+S7YWE//fn/8/OHXX99HWu8iPf0DfvrHh7+++522ef/93/Lp81Skn3/8/NtPlxtlm+VdvKcz7i7eyy/19W7y8l/Is6xNexf86bz7/OGHj5/fp8j9tKA9+bh5CfTp57+//0T13Sd6Oj9eA3378vGnT9++fH0fsL0L+ORT4S3g8Yvr76I+/fP+48PXv3989wH93U3gtavmk6FeHtKXX4PfP62ifeHb4+fpn/st7E8f/+vTz5fpstu7T1ufzpiXsF8/vrxsXuK1d/Ha9w/89Fd6F/n0mfu7f+P5r+LLT++fJ/X+7j9y2vpcoPcXtdW7T9T62yvDa7HnH4gI7wr9Vt7d/Z//El/iff7w28vDRLLz/g07WkD+gYBfP375+tPHr59+/uv7z2jvPuOTE8mffvryy+U94lbfhXr6AfDLh6/6zb17ArxuxHkyFGV1uX+5tvb0T/g1ZjH6M7Z3P+PTj6aXadanX77xL3W++6U+/fl+/eXDjx+/csj1LuTTv4nXG+y3L++mvdebeHDK3QRkPH3l3Ye/xn3tGnr/qZ/+bq9hr5P0Od49Ip7+kjM2Pcnmu4DPf8Vvc7qXC+j9Sty6j9ien/X869NPf/3IqVXvf1H7/eP/HPL/+fDv9xP3++9uL8b8n6N8/vx613ldRdHVTLu/jbX2dLwv//rtl9eVwn99+va3L7/tF7J3gcfdDbett8WiZx+3P//6r/ff3+vhQPfrrk8+X3/59O5D/R5iv/+Nt2fMLPb2h/2Sare3FZLYLLf/tJ6ceP3y6fOXv/7j46+/vkyD3+VWVG7dv8s9mf+//PLxZ5zsvx4AevfN1Ccnwr/88vm/f/nw7f1L0hjvpvu3t7Wz4U/Ovr5+3Mn2Evpvv374+vKB/ynvsvfLdvbsxfr104f318H9BTrnk1fT97dXWW29vzT3YsXL0+Vt8vH7Um/tb6nx5Kr37/+i3mLsfj7fb09+vafXb7ufdr88/P9gNGGId1Mlf3v7Xuvpb/n6Rt/9PkmbP3kbeAv145ff3j9E7hcw9tX5fLT3v/37dbK5E76/XfCljO8r/v49D559Wfr+D8a/9O62e5e/rf/Bz3/55d8F6+XJezgSlN3PVlp/WyEuv//o6+lMzfCvlPRepu6+7tHH2wX17PRNFanee9x8u3rn3B99fV8E7G95fLO3P9X+/Xf7JLZ9+G1PbmSNffp6dz968kt6jfZ6H353O7+/G5X17PLoS6gfv3z+/OGXX+WD+bsP9keivaqoTrrtHij6s0vJ38O9zN8uC0PjPudK789/xKtBrHf3rvXs6uv3WP94l1uj3r9h9Gef1C/RXl4xXn4Z7z7Zu+XH+ez85d+fvrxP9/sbx3hyuv/Dhx///vH9F3WTmdBTMX775ef3d556v844nnwK//Dh108/5kT5/bzI71c87Mkl5B9+f4q9y9P795fnfm8/8IPrXhSeS/cfrovP79Y+n1zFDmV89w29e6fP/+pNN/3tVl3f1kzm263V9lBd+27XnrS5Hz7+18vrG97u3q2mjO+bAdaT8p6Rr5fvfLcCMt5E/SXuc9PEjPt9Cejf375+/MeX9ywWTQ/up9//vyKDQN0/jtZzq0K/B//15X3qfeZEg4X7z/vcc1JDwge9N9X1R35vv374p6xclfvZ+H669rf58+0tO77vAHjbMWDN31Jzp3F7kmX2B/n4+eOP394nUH2XQO17Av2Rr+23nz9/+UC6OO6/smcT59vLu+C3L3+Xl7bbu8/5XKiX//avn7/88OHzr3/78vXbj7/p/fPdnPjZu8xLwPfz4fsFgf3r2TeO+fYL/D6DGm/zQt9D9W3i1d7Qtd/eEuLt/2e8WfR4W4Zf8+1KL983jKwnH5GvP8AvX7/849Ov76eyq93fS/aOmSei/fb1fUK1d7+o7y9D5cmH3Uu8l3uF3D37u5i/7yR6btr4g66ar/ukf/LV6ocvP72bdvb7HUcv8+Enf7zr0rOVu+lcffZ2dXli2v3EtT+bCxFGX2nuArXv+6X2tqUnQ76/Qt7J49vmrP595eDtEdzfHsHltaHI/mf7H/lnLy9695PvJxf1f6C1cyt3X0r1535JP374/Pl1Gvh+8n7/XfTvWz369zmBPzlJfY3+j4/f/vZFNsLdfdBZ3zbCrbddaG8vkP72lPG3G9DrToz9p/q2O6zU8XYBt/r93e/JW8OPH37+4ePLnfdf77fJ3S9szPq2Te5t55bf3nbHze879frve0/G90/z3KWf66xfP/7XZVfTO4B7crr0cqn8+Pcfvvz7/YPp/hc6n9yh9xbp5RX0t3/8/Omn9yHvdxLGSeNPh/yv3z5//tvHT3/9mzyI7+Yb88mlyZd4H79++vL+Zeruehrj2Tiyc6P6/V7Nt4t/+tuzrb9N0d9WFP370+72fYWllu+LEuP79s36+8zpubtGfLbLWll/t1jan06Ol1j6pHlHN0+q0PdAsuha7r628eTyT8RKo/z2BR4a92sn7clbLa6p3z+h/W1R6fs8aH7/3e6/WW9bSf3thvTaVvXt7v828Snm329J33/zrXzfFPf9eTH+39K+dcdxnEn2Xfb3/tD98iyLxYHLlqs07bI8kt09PcC++5KSMpVBsvpEnQPsAv31zIQpiUzmJTJSiWo96RPIQ8SJ0gacQh4s9X7rEirU7L3xI3Kl676ELUlamR8h8aAGIltNsjkjllPZWy6jXGJtL7ZbXNi+1aBGHYlSSNnuvJIb7jac7q8HLsCmGYSc2PZiMTLZXq1mMZXpXCrTsirJ9+gWMJ+n6ceIrlIDaYqGjJlWtOt4e2LBrgEvqSEdyhXsY1ye04wXHPjMNZnxXxnF6Ho34HprsEHmf1fA63S7DPNnsBU7yF20ZK7ofJvuw2Yc3TNjwRgYS5Uylsg0myJHuEBUIqltK5qLuB/THRPMRWv9dJIxsaLhsnKbQyjIiojDWbYElYuy3/ApgT5F0uU2vNvNgS2IBkQpsvyzon3c0ByXQBsi+XEr0vT8GOZ4ZcBYIckUK54Lmp/D+TlcXODs44OHM4q/pvlyGU+36R1/BDgsZM12/ZHZ+27xooFdQrIOVrzwM1fAqvjOtnk6K7Mej8dtxE9U5YBJXsAr5nRGJDjCZGVDkBLsSj8M1AKSZ9dZqvHzMfkWt9NyDuxWaUPBhn1aB/I5zvM0j/fl6dwErOhAFq4mGzaS5asMiMxHBpGsvwumZ8CP93ekNldw2/Xk1xHE11uY1/FzVu3XIW3OBhhS9EtbDWmFidL22tMgUYU6jZlmXEt1HyuS07nvNfd/q6v2eXo8wtflp5RbShh51Dbgy+kJpYwGerdq1nHawNKrg0PLhtMboP/vAo4OHLScrHO6f+pjE8+JgrVlsLaMB/M3eMhVsaFJW8q+kJCyq7XwLRtE4k8vEiIbRNsYS/VjK02SVC15i0z36zh/bvdFKjm0CrLb10jedhZ3SzCim4rlBnqLG1TnybxuQfq8qmGt33oHSHFqcqhok9zgHcrvnp03lnp2ewrzmqSTGujn+Lylga37WpPtGQ54ec6vc8DING9SSj2SFhFrVchu04yccEzUelWySyux+5XWiSQyaqUU0UrapBOnvpPOrk7DdenV7TX6zgrluBx/OhqOagmtcq195PLTLpqXhyk1h18pZa4ic9a+nnga70Hw1EAdS15EUZBdEAkGfGF3TiXp0loiy1qoT42Uljs297f9lr8+DkKZ+1+Sd3bO5b8YKYELzN4jiR+JgMEX/tabug33d7TalklSalFL+sHlMzelGF6NzE3HMX/y/RoiiqCt62hCva60wCp1Btax3H4memvg3H8bKsiF2ttJltz2mqXfl9y3eikpL0tLh85r+cZ7++fp/u71lZ9RgCfKhoEb7jI7Qznco1ZMuNNIqleaTdXZo5D3bCFio1JtDWxp+ksPl1lG+y8rcLwPLb+Qdmt3vlfUt1dZsO9hbZnf9CPn9tIt6DjmgS38lkbLbsLH75XTNg/XwWdgfex2Gx9v02kOgjewe9+F/xIVjB7ttjx+C0v7S2CwC2QfugAvX6JC6E82zHpUF/m7zTT8+uWQsCzaQ3N0xtYbPSakoNoKMpY9e38HGfcGekcbNoHvYZK9vMBjaHr2+Dm4oIMCkvcdSTo5z0NE/oIeAa2ydhpA9CQ3ZsNek4FotA1+ptURcqusmP4eCA1PabNYDWu3V7hUz5F9CfRh3tBuQ2SvoUs4Y+s0K1zYKbzKHtuaz3c+tAdLRgcQcrHWdYVMaGaUNgHYkKTkHS1sPc2g8q219Y5sVBTUYIE2N9SwnrxCXadZb4O4kbuHnUMabMVOfG7QHyFbZTfAad7auFIda6U1hw0bDKywoid0CjY5OCUkQW1DnMP+sh7aiLJvbXLv3MVfvLBPS77EsIxoCYLCXm17JQDsprLXYDLTFudS+SEVW0RZlrfbhBmX0u6FVuiPrRSgVQWmV0JSpiFuqbSEik0rvGbvj0Wv0jKumkYKVwXZdH1+Pcf75jcmUuCV5Wy0bAX69fyjUwIdeRlJBAljjcIqC1XaNlWr3FWjAU6fKztKuLB533Mv3f/scgqa6iqbL+iF6J2zvpA3AfvFCbbVOMPbf1lqRLf/gqYUJf1SyIWtG7oS3kst274WGkQj76ERfYO8JzNPZsnT21/wNcEcckZms4HL2mGN76CwieVKiAANmXT0uJ/TZbyOiGo9kf11SR5Bvp1kzHLhFxTyHvWgVpq8kbhaM0VNrnmJo3ux1XfM3bh29eFLBpEqzvheTr//Qntp6TqNiEOt4wsovF0yDKmZUNTRPF+Xc8bnku53yCEyOEikZCfFZXh7QUW1ATUXPQbOvSf3lQe8DT+HoMfIorYt+8jn+fcDCXbmHpPyQUFmmXY4rS6vhhdJWpZhTkaAl+F6CjL2he1gqCTp1kpiuRVyZSfJ2a7RM6FFErkP1W/Mjs5PkmSyLy1gZHZAHG/JksqO9fN0ewUpU+s09uwNpaov7vQGnRKFJdbWylqr6e9xG/CM9NBXk5F9ixvO6XZbo0Ak8EMc3ZO6NxtgogPLvkCSJ7BhXWfvhTzwWaEOT7YZbnBYzisso1JdhYaU/9oQYwlBm2MhSQIHFNZVIduZkUmDmELSwfvvyWjiMs7P319KV1jqS8V6OuNPrLNAewdZM7jcLzWedZDTU+++I5M1F6SNNGA62Ibuy+RCznlYPtCQV9Yv1KoXa0B8D9klCAvt1d9KMaJT3UcpH/WdEt4b5Uoqf7IiycOygrhdxb7yipRTucynd18lmKcHfMCmhDIBa2ocmv9/RAKeItlduCFND0QCigTZSOORglbfBsQAa5I+uAGFnE7QgqrJHNoKFfV6NqAZVpNJII91G07Y09kAk4dtFvJQ08/gASEFXLNmyiEtz9OMaWDI29ZkRsHvgk0Kb7wvvhZzvTrb9w8Cw2ZlvTwFTkKCxWGdFUyf19AKpAFhXpDU38vr4bx553mnqFU1pI5IFSEfzW2ewMPZxvEfRIT8EXnkPeIXeUj4Kk3P4wXHtYVv0ZCy6B4oaMrtQMSqJ4WLPNBaWfQ8EXxhUGgixRA8XHQ02goaIMnEx542DwVFvMgkEHdItPsqxL88gu4n0NdqOaO7YbltcZnut98RMdz2B7nv8B3M9SugVwyMyJbU5NnQtlwvxqGw2UhWpdux239vTz88ZcVu2/vy2trUx+X0trh/5L3tWISwtKerIU2eBX/4bvG7OyIpbKtIQ9q+9WoMGdR4XKB8SjoCfonPcVjmYe1AD5kHwFAjb8wQMtHWbi7iLjt8RG0wIXMn6y/9XpEsvM2faQL8P8QN3P8gPnMhzTeluI8V6f8O82kZhn/O7lMo8+h+eiwfE7IZcuCxkmyGFTwKjjrI4vSsSfRYyaZcqx1RkXWcYTmfHsPH8/OGe7q2e5rcfKpUgDFqh2Xx7b+uyVDwAA2bmW2xpCZD6AMtSCnZTcZ+U38QIsIQqObXwjcscjIvsoLexsWXPefgmrL3Z07Gq1/Ssb3OJeBxvviK5/+rAKxDPbVvPKy/8lKAUIMmXcDhn+Ec6O90PWSBSGnhHegrVhgoJtasr7ZhjvdjAMDF7cfxFmsZ9TWwXMjY7f/yA7HhtunzjmTu7T+yaeDCBQ7xWMHa/A3OM4t9T0hCSbYBcg4ZfQLsSjVMkSYaKNuR0aiBTmvq9g0kMtlrNgUbfzLQfWHTaRbbeb+J/dZAPpIMgJOwiV2W213GQsfTYWxtPNeaqLaxdmSb0AZ9QnW1BmTn2fTpBhXUPAvoENWqfK9t2j1J9tkH2SSC2QZyqmSSwcFN89MFLJdr4hsV9ht9BzBMHvcNRNpk2mLDegSqUBnE2Dm9LT3W/t6e07/j4zoGvVE24mvYIG2D/RkuEW5l+ls4k7SEJKkOiHEtqZTptcROa0c6XqEtUK4aJWf05Oa+nu7n3+HWa4BbV5P0CYX6Q/tzaas1LUm+UuB1RyPjDIQrGzJdrIBReqYAA0HeyAqXoMS1PRT4SOdfETftsvgtWv4OWYC8pgnRdQ4jeUju+/VLjeEONmRHag1c06qK0MbE5myuXyngdiAh2rGPmhC4KGCmAJkMuCbVmjobV+cdWT6/Oh8q0DED4XOyX8aZzFuQDyztiWq1KK7aFkJCOChJWXP0ZqhuEsnPiQUhOmBqtloe6holaZDshw07JfbVgEBNw5qhFc+bjAAMLDDpEV/HhHcCjOn8UFUnzdB4v3yh12wLMhUZAyKcd//i9Hhho4GKLOZ74Os4L0GyF1Kq9P69X+4rTfMSJCzhWiB9Rvdwm711Rrw8Xd3HjolDFeRVyUowAPvU5XC/RPuohRPckoHaNfTMahCGzsn2hBUmtExQL+vICOfq/gKeq7KuYi8TAPNMVc1qbalstDe9U9e/V8mro0W5J8W81rV473p9+XGtooHiDpkvXkGjDdeA48B+PA/lxy758B1XBlUU9oKxcAnv30R/7DDPHXLxSkAfX4yHaiCFTWYRFTjUZu2AmteSkmY7XOITQ4qFDAJWtEiPM4cOG21I7HTqR0aWWTbXGP1OMP3Kf+jZ22Tys1Y85//laRDn17xM857WwsQCTMNjvVGH5flNPsNy2QoEyBGzvXqSq6/FdajJlpztV1632xLU7QubJKxJUtaKFiPZxj3hvddCCqyFB1qTbCj3I59YS4UZK2RU7FFOPsU8jAuKHWXInyWlPDe8tQwR9PA6QBhEScrpbYARWG616ouClPpw+wj1yjsgU3TsEfUwX9S/IOPNfgSLl7CdlbWdqqYuym8yPiLPVOatVEZ1RfKovWNwGQOl6gq8YTKv5pE2kx15BxDg5koj78hqiFgBjEatsiVZHL6+7mf8bNCWX5D9kNfXv/8GczFssY0dJPXu6zCntSPrc08ho4+PQtxkrVFQP05ItwPdD7GSsm90oNBBSt//ppArp5Q5WRXZKyMLGYOYEfjqLUn9ELD7859gQg7ELyUZXr8P0+fpsfd4psREfe8RHGj2mZ8wFQ9Nl33yoiAjohAyXcpw2AWAc6c/BI/pujDotCBLoSlY384dQMNMDbLeEEJ/OXsQiob0idzBP0/jPf0JoXRIMrMUNnLgsXxN5tQM3NdlvhxFCwvS6/LYZkgakhPs9lVWfkH2mRzIC660sBFf9Y0ddj/7rrl5V6jEpdrDQLaxGsgAzB4BMh3owXxh/IqizjaQb0jH3UOl58gAfUUUhRoytw+wb7/RquYw4VfaMKvi4E3yr8H8SBQp5TDlV8aZVaTPCejT/Iw06S3NtfqGDbBpZpw/B2z6nPQ+ATLYW9aeSLKxErn+qjlOGXv72596+z1P4Qu3VkHI74fgPDuvDn/nup1CdLDBJeq+8/LjnHwOk2qF/VUJj7fRhK1OFHKeDH+h6Ci/0zJ4bvPdt4gHs3lgatM3LivBTu7P0u7P72x6LTUE27OB7fkdS5DI4OYwfFIT7qxUt8WNusZyW7ovjn1ONsU67DdnqpOOBYgTH1RvshM0QF6e4SjsHESKNfRixQ08/m16w31gyXUqmZ3Xxxs/ZhzSLkdCgt4y7yqRsmu0ptKRo5YUPNwu9tLQxyj01uhI7RXF9yHl6p6f7onp34XN3lckxUaxA5ehhrwzm/VQtOTptj1gZCJbAeOj3cLR5uHc1R6pZtk+dLbrxmFF8yUamBxYkzUtQUpvIusRtMe9RN9/ZqZD8IVhNA5/dytgsFB7dat8QsEb3aSiUg2JaJIu48F8j6ondyIaxNqkuuuGtngjGEbblf3erapZqnSeyCz1MnMiz9QOlKqrV5HC7n4hyWi3tsG5u0los3WebtMcjViooR2q4M/WWXRw335jt3uOim8Ff7cn1DGtHRFXvFAFi/LYed94q1/xFmugn5a8m39elsR7LeG98pt5LSWgoYGOQ94DCfm1lS2/9cKhzrNjqgkptr1i/46leqx8hibRvmEV1nrXsOo+wwuwr5I/yOnqGXQWi1BHzupFrrDLefCa3M9U9A26/ySzzoOOm1z7c5I4HFHtiSLJcJ40GuujwcwnlpvrodYmErzjLceBf9QNKXAYauDo5fxxTo9xLGwWv5LqXsNHYl81NNgrqhLyTcM7pp4yGW5vODZS2iSrKBuki4aGyx/cChi6q+EGqZWz/sS8JBwg2EuNRp8tWer2wLfTM0o0wuwIshLvsZI0AZjB2PC2czyj2chh+sQxcZOUxPWIKxB4KDCZhpzRK0gfY1DRrkFkhpwmtqJ9DPPapRr7eTAogywUrpDx8InCElFrkm5ksMJTU9oj3mhDUEFSSB3yX8t0T7gcOcwY0OHMx0zU49vTX8z81HK6DjhZPgc1fhGDqA4Fa/qJfgy/w4xAC41TLdlB5LBup7fArwPt4iPrRIrSCeRxKwdbzYYUJAlFMAMkewUr/akgqcqCGWdtoLFLC9AFqXEBuMGCrX3m7xIvjBYZ5bYGzROywcujhapVbQ0EQbI+7JC+KCDVti3Iudf05/B4ZsI3vjsU1Sn4eP7TXfGhg1xDj39BUmo9mFtaVPovrbPQSAm5+EaMdT/9HN9P/qxE1YMaOgZKPnXt2Zv72B382sCzJOeueTx34779DueedtC/zic2V5Lm2+95uCIckP34bGYkcm7vDO2olkCo1rhyNxo6+bHpjsTkETKICczl27o/SIxa8K71rqj5SESkIMhQkLQWhUwdF+iyLvjM3Cqf61OSodxTDe0Hub6ojmwJ3bHDhBWQ0nM+fPZYqYSkzQaxg3R2uNkBXrzwC3b61sCbzHlvOlbes45gZWSqct1M3zhADjz5oTowbh0f6u8SrbufeJRL/K/gbm1gt35vzZ7vHvkcpf1szfd21BeAVk6YZDV7kf94nrr1tysRXmXHlSmkRwi2Fcj18PFFoheqtGtkhfM91K/7cEkXI0HTX1NIBc09CrDROoHerxrVgpzrGIHHLhxoIaqpKshxj/IDsWsMuoO9Ju7JsY+AG7wRGxr0mu4kRz0CcOJtWIe+V4eepA/H4MHSrUP/zb03D7dTeOByaAk9pj2R/OQQOlis9e1VI5odVxJiJ1619VJ1PhWr3erw4xJgW0P7CkkDVahkpghEAVQNhtWqDLCjGpR1FFiFF8WM6ztA1OUZDxtczNOFBCR/1Rxw0fN28Ly0ETsQg49jreMxu5xse/fAftLREmurwLSjhq/lP6a/kD4PX2S/EFVtUhZ8KAvsx0ynr5dikdnxmPsalmcgn1VDxaAkh7PtaM8p6mKAtqz9ubQZU26Ro5VKpMNFe7PsNYnEf6t9VANWIC3vW8aMdTq+QBq3er06M41RSnUrK/6ufszDz1SsCIUytql8xZs+PW/zyAGlHYEaSPjfIDH+/TrNa8toGIlbKTG5OopvVA3n4Sxn0ru9f78GnINe2F+oeHZj8qKzoX2pwl/foF8K6le5Nns8SrJ1zsAGYJUFK3W1tBchsM/T/B4QeW2TX6lE/YIUaYqwcZMB3eAblPSvb3lbXy0z9SJ4Qvo8LNPt5ybOHmZya6hclnwpI6lpZn2/SnLOrMy9AU3G2pabRA7PM5DB9mrtO6Xtp4J9cVwtP4nPNs/ThDQs64NVdD/HinM+3XwZOWGsrEYcKYK1Y8blL2iVp7tXnpsO1XD/id+is99C3UOet771SG1TfhMOTm/haWu3tbQOl1Bsr+tBBpAPQQQwVh7ooJGInIdhEMOceAXlSVYgSgFDagPw5Go+67qsM+jF6Li7bpoDWkOb2U+jgTPPBV7c/ry//yH0sD1tJV+2WF5vqURnDe3h5TdeRawLldvKZcnXQXaoFEvEClSWfK7dIC7j/Xx7XZxn9hw+H7dwRFBuBWRLPjbc7snQJMHLlFlVOSscpbBp/8FKhJU6q/AbbUsB+PSaz7EmaA10wG90L6WbrGp71bv9RZ+DAy49mR2m/hb81ogKRJW94ti2dgGaDg1dzMqbm2n/UiXv/j+nFGvMegtNr3V8PuUfKk9XMJQlU2GLnC85puX8KsvP7fQclHzE/Hqe1wFZH35sHvb0gxj17o7p6Gpt7FANhFbevgSbvfIG6FspcmAbYGHV/K7+NQw/VpJQ8gPbxi/JWxTfoB959BjVsqZ6LbvxEfb2faPNY6nNHW/sf03zj+VxOg+eOBSzQYHq842GRIV9nt68sXifp9f9slJ5ER/Ypjzl9veQckCtINUx457cWG5vX25D3NGfWSE6UZzuRN2qk37sXjJHvebnM5XnKLUZpNRRd5XMOslZB9yscLynmOiVHdjVygyqTme31ZpxkUVrzj9TRa5Sez9K7fqvRKPDrZXb/ttaA8niDjgP5O3+cVqS3FIrzVXmh1PPGUuPmiwUWZGuUt5TzhI0LOx6s3t+ozeaQa3MHquc3qBL6qPntpu+1FvjaG9oyUvU4UeaTE0H+lg6RLAl+fte0WC4uEv5McxeNR52KxDr5PDojpNfEhNZSVZSep8qkjzi1iA1YD+iwQVy489UMcxKgbHEFIcdA1kNiFLppSxpwUFuc3mXgIbUgufGmUoH9oeiqG1l3xMz60Lpg/lFWdESbPcYZsVlzdzydTHNBp6lzObLWdqxg06j2qij0AQYqSCxom5pm0RXbW3lGNxhpz9cMlaugKHESpF5tLUpMsEbhb576S9UspBsivroZtyPYaEenNKPyEcbbjCZqgY+dkX2r3yMF+ePDucfbxOOXAEiYc/aKYcm8s3JWffAQSGjMAOK8gQdTPXqSLfKw11v08lTnt1RfgYBad+CMjopKeBBb8P16VaJemgtiKGT2dCP8f3j5v4fhdpg8lhHOnkKdSR4olixg1R4T4oeGeS4U6IGWaCC5Hsr5OLNti8/jdNr8SbhLZCZy0BJkKz+IrxPnEzzaR5vv93Xu6A30GcgCEgGuR+THzGxvuhEjOfnPhtQVsY2Bk3IZZnVduzbOHCDTkdb8GyldbHrRXzrqOmWWl7UMlWpFq46JCXJqGxdUaR83oJhJZP1Yf9GZePFXldWKaemUce9VW53T9pQ/2PPabo9xwceqwZMKOdRh12nxmK2IlHVaalXbpq+P+isR9whf6djeN0Dq3I+2WA7XmIZ2g4c75bkrI/vdz8Mc5rf1uO2JYORsGYr3DXZ+LDBmt0MiFa1qCF5U+Pn6T2qv3Xgf7SkXsDobYy7adwtE+1rGA5Bxq4bnp8YeHHO3Xi/jeF9A0MMyChzSyarTx9lT0srqNSQBLEddHeVbsP9HV9oYZdaZ/u+ZKdXOvR5OC2Di4ne52FZVm8D4G0akB185v/b+zNybDuo0/TsxgwkkJoeRO1E6cYFgeS2vI/4hHYDSQlXDrrOxVARX8mnaGKiFIteyXSvvDn8U5I14xeV6jOtwb3mH3A83cZ/8d4sLUGplTunlaxQJ7z9Tnzq/hD300i7zPSuUgZSpVLH1fdWuA2/Pa+k/VA8D2ha+f8PbnzN28xcT38gP7A0qfTXtzBUhDXjB2CQQumgxacn6TUbns+LP8fP4TltSn8JKd0GthR7Bj24f/BVXxyfHnxI1qCvgGEhtwfFuYysCIw+PrqfkKFuHnLf6KQ/N3pGyujfoxF1Crs1oB2Q7a49kFPlUXvU2XzKgfj8GJdombn91iWpf+IwXXw4pBIThbW8tVrEmiQSjZjLs05KXpNZwXHZhAuxUmVrdP1BlTxKS8cdQb6E5dBHTDThVVZJoJPiUS85q75XWqP6jjrx0XmR5MddTterT7nc3xP7BRxxLhx2gJtKtRdDclv7/X2Y46GpheXNVXLbsUkG9xu79wPnGjLt+21R61sqtDLXkz0E7mdez8kLh8OWAu0yycblZIg/Lm+De9c+AREUbKFQQCpnjFt2fIIOvBYsOzsBx0F5aR4EgsiBvcOW3Ys8/TyNt1OQDIAmIUmriaxfVWk7BnsXL85pnX8/gndppdWkQbAgCWkeMilGAr1zWu4lE7wW9RoUBAtIlpJpXQ8Y7aEcboz9pYqjpZ6UvORWC/iS1tSGdikC1VI5r+Ub1VLpbiSN0OjL6EjivKx9S5MM5x/4FA2Q02uyVORBRe0lPBAQDZJsTMSLFIctW68kZXPGJTFjvIGpz41KXLYkEcqB3sZ3n3Tzsv7TerF6Fu2UVmPNLWulLI8CCHtnDZ8PFJepYdflGp/osc5rkiO2g7vniC6iHGhNZB+/w1uHdgdZGgPVajyipWyp3fTatpTprap1OHe/0u8rOSHRnlMZBywSWbX6FLne7K3WfTqyiWRcVpZHsicAdCZYB3iJR3Pk9tIqS71qu2MTs4uN07ql/VC1fo2e7NQTSInQAiEP62WWckfkBVlCEPDQZbOp7lZi106pB/IRe21by3RHlSp/UZFtcrKIMYg8bTq8lVYXHRrUi2vUa29bpj9daj61Ivvp3CICLm9uDVpZamWRrKeMy5rSQ0R7n5MJ6tFWwDGusm71fuS0ZJ2r1kClhfmOdhj3nwxuZUtuLunrzGGtnzcVx9nBiWWpjA024e6xtxxsAry0m7jWndrTEcVfzvOLhyPnvY099ZYo2GTq4oV5ENAGnofryOZRNxbDc349PwLTYK/2SrkMbMpl8WIvSbMLci8kI93Dve7nj7eTv9yvI2r82hk4ZaWXOZsfcdg4IaSF6KZlMwRLPGqmBX+5ZfMCK1L04qB7llREHZcvxW1gFAftu0UCJVarTQdd9eJM99qTm6lRLVVvtCLbibef3SOq1EifOsd49DtPk0o6WEW3TqxiL2noXm1ipo9SqrRARTYfb7+efhqIskgVlXHZBBXSiNAsTCpdCCLS322GoawOb4c9JdJTiekuW0bTZHhN9ritoDH727JCt/9S7uHDl1UfTUe0yb8q2fpK/qbO1TWVoE9S9I0kpppSCTSVXkhaau7oOHkeTpfpjt5aDTTxklRlclhhD5jVBS6Vb7fLS5CA0VxkWFxL25OtwQpz8sDjoUMMaVmCVbXQ+Eu/suXjNAcnCNhFBdlu75Cep2es8ti2kJ1i6w47lyu0wYXN75ak+IgD+30/h3wPY/b2YyDjfdVDP9ilcmLkXxVCQiV/wwpfOSdsekR6bjXMPc6VL9CSnRbj4kcdrgK9+O4hoUey+scUqaey7QdtrcZFktNSy+t7ZYZ3B9dB7EOljfgt7dX/Gk44ddbeGOT1F0igtfC6G5Vd7cncqYN7m04zpnMhK9KSd4RD8lwBWBxwGZqjREzmsXahyWV4nOZTUPrtIK3SkmbQI/oyPq4SVOT0HuvILNbqi0e8gGCKIufVbm590CtS2BCylqYAd83uG7YoyMpd5DHDSOFGCT1sydfjhUNDW/gsja62I43KbTj9HNQvWNynCsfStlACJTfnCruEd3Nn+Wx5R/YieC5M9LkbUJKrycRUWKDpoH2wJ0spIfe8Az2/juxIjr5kC6lnMvb3KMmpC+DrNyJA7fYF+YyRd1zYSklFpu9XmHlGU9KC594cA+klHnK+F7nN1ghw5SNFLIgKmuTpjRvHlH0G3CtSa9cDJYR7mx7UtUkP0IPNw9XFQc4Z8Zs47guFHvaMNM+3CZ60tETWNlPXRRIbBduj4HA/nSk5BY09pZ2Q1EiracFqDd88Jey+aTZGm6qyBqEVvlOnKXotuWfS+pZn2t6lEkU5v7Hf1wa+y1awDh7TqhFKEaxgpYpXYdxoKCiQTkuSy/15+jEkPLK2BYeDfP2enXhKlRJhsp7Eetqeq+Pp5Z6Xt15W2iIhQSTpk8FKltEn7WE9lv60f38dhqGtcHpVistcVkqgExedTCr49QQdESCa2ZE0Rf8/xlVSPEjedSCy1vXkRtrgxueA07VBhqnPyHe+nWd4z7aTq9Y0ba351Z6UyEnZih6mqWXszhg/MUFt0+lSwxahi0r+UEsBvJaURyOKR40qnpVKwaw0Ia3kw04T6x1ZlP90Xs1a7osiug6u7pYMoj+D4LmzlCC3Kh4FFwP3Sk8mzD+neQj16PoMWIlknfdz+jmo7uBzQs+0A8+UPBQOcEuTD/NzShJP+hb4NfQHsMCp5pYOOpBIlVoPu07FDWK9voPzQVKuLJovGg2zTyz9RmBozCC9WQEOv1EHbPiecx8E7PVALPDDSFGrA+vL54V9SSozedjn6e053YdfvxwSamX1HXBQWfPvMT+2jPfyuCErvIe57llP3tkecsK7H+J41id53Z4jGFZ7+Fi+14riHuwczhyyVc9aY5Va1BhdxE1+bP8Dm1QMON0QoNUkYezz9XRo/yecyFJa68AyhNZ/H7LUJoeoia39Niklq1SLN1VLx2mj3be5tmtVmjfT3HveVUd7wOF3abKKdCD2QQWB7wi3E0mvcafEVJG2KfVhE501OznJMbpP4TXT2VKbu/c0iCFFPyKtNevdOt9G3n9NBpQe7zzdXp/38YLNVtCq3JPikh4uemSQCenJANUjueg0KCuA/G5PhqdRT7ftZ9h3dy2VolYkSzv5R/2huloeCXSNzTSNySoarG0B90tiWqytgdek4MA+x8H3LUQvHtiCPZkk/6qcaqmMrVQJdPREr/FKpqHsIWldana80oCrJ+vGZj2nX6c5oZBUt1BTqzSiZU//8Qvz4K+k8OhDxxN9EgzoOsoBr0twDlVJKCdZW6uT5ANMF0DtYi07Qz2IfS1DoCKdhw386VzPebjOg9cACV5IBS+E/46YNLBt+RKgHAQDSWfLSauUwCtBc11qXCThkKi1NodicifnWqj5sit7yfC4cy1/yvWs58esKZWXPcRgS00XVMf8c83c1Cq402kBuTvKHaTsg39hqXlBHZAe+29scl83+QxaX22MTMaGKZ3Ywvr7GmLXQsxrhUfZyd/0qjOWKbHuUK8t1ZxUqmxSq9PQqwpor2FvX2tYT3I35DFO83zCGj1o3LPaiyhkiS/ZtpwerdBkkXcFDkTPS8uMrEkHfgOKFb4hs1/q4ZI/qAOYH3PLSVXolRyDsUeZweBJ1hkIh9fYzEll5E24CG7FS3FsnG2rwbbxW8nPkjkHprKy8xs75cwqYSVTVkmmlXHVbc/1udw6vvFc+zrcrbA2ZSVc2QYekd+FKei4XdQqQ3VK0VXKQaZZqUyPguoIumfm97IsJ+GtdMD+60kGsAVNPFdpn0vMmPYdZHpNZNqgouo67rn4E5NQSinAg/4GVFA89kUFmw0n2wgFyucv0xIjLWyp/2fUxFuv7FsX8p464pleyZny6sujQYjUg4/HrltlzFaoYp0QIXuVWMqUK1Zq/FpqiqBS+axaXYxaXYK6P64x8pO+Pt+G+eGumFhb3RKpay1a1qRY8nS9LuhV98BYyMiSTtBpBtPKarKFYhKuq/vbF3wVWwDsSQbRdL+5rfU6vad2bgUKeWzSbnr4bpzp9byMp6BG2UPzY04qEHnAt9ftx2lVDFsSsHBsc6195iQ/2v/AcPFzoLeCYNBuCuIB5GgGD/k+TLfpHDU+9z0kS9it4wDXhonxfn7NXqXleXqDjwVKFmwq1MDeh18RZA6Q/Nsc7wFU30OYSOrcbFCJFG0PMRZJ/fBoey4rztD24NmQPaQroo/cPG4CE1wJcpg0YEZvEW4S8qoDxNTL7ACUuxQO0MRzwykni0UecIXyQwKjNszcXjkFq4noMd0r/AKxAET6i8/RiW5gPmBN8temRzwquLJXQitBcacsSw0GMw0GM80Rayk+r0gRBb8E5PdV9lFaieM7yVr1eqFneqFrfibX2rtbAOdT7nz+MAiyI2FJYmGCx1/YFEp1KEwoX6Rhbe88vo/30y3yvxqgTNdksXGDG/wAYYisSxu2NeJEFezMYxRDTXAs4QSRpuPryZB4535jiV9RQOE4kkbIaqkmIO2dQ7YTxZA61cFzt7BRBMhlZL7d/8AcpPpsx5zSGjTXprmbjiz4xYMJS1uAbCU+aKVW1WkLq4TXvXrpmcbjx3iZUkXvK6Xk6LzVvCFrdF9PHkGXi/O4NrTEJgBC0XewwivDVk3ZliU7ihCwYHDUbrc1DKol0XvIBORH766O7evIAC6h6oc+qLY4kX7ZBvic4ipNDWqyrL6Jw1uGUDsmDywW/8aXdSx21F5cAX2TjT4ep2VTsFhWtap1jvNtfESNAJ6bCBaRMwcH/J+Q4TywByI9WrKDhs2enPn5uL3cnYVKvxAd9mRaI8zVurDXfhQaJU7UWileSbFL82ItAj61pBlbOWutlDI6baEXj6pX5b7sIJBpXaRUAeny6CVX+YZKtRE6sr/LPZOfxniOOi5gwJUyBzrSzYyVQoFEIh5lrX/Qhk+dBuq+CnlW5tVFuk7zML7f41ldQKxktUR30PuUAoTpWmTxcQecBxdIL+PPtagZwMLMFbLquMP+nMZLAhE6HsiioIgtJ5rMOwjaMtaWzc4ozr9/DL9DTotN34qirfr1ypuQPV0IqVzFLCqSReRW4CIylUNLZDStagPps62nJlDZggu2J1W7pHH3dBtPGErY9IA2E+U1ORHL4z72fFgiUOmgU71nb/UVdPlwDuWGnJ5eBb5UQWrGh01Fy9MPcQ3T2pA3ICk1O3IcjqP/T/Zv72gp6YwMAFV71UGTN97ruYVoW2IUeQMGWa4RFRYR70w9aClzlJLbLqXMW5GP+fdrWGL9W2h/IvMXf7/G849ERzJ09bQkvdV5f5fpc+vYxZvYJhGkouXePHda5kHqZ2BCYXRkQ3ry0mVuhOUv4xKJRfUZmNP8KC1yZ/EPP5MwcZY/aCp/6mKQrP5tAPI+g2dM6sdkEALnZO+jQ/FzyNwHQHX+jVy0sqPHW5C8cOYAsn5kLuT4qdn/jB/V8BU+BNs5SSo98J/T+c/rhxkTOXsEbGMXUg/hxidZFw4u6FnuanDXScrqTk3CbWfnEUhh9qCIZBpW5ocss0pHVcedR6aO9iWcnc/2dpvOPxL3XgVHmq2E7MBhXOM+IERJJKl+R4tmE1gTxhYgBeurpsYeBPSkNuuWqncTKf6b+KHYzPQ4IZQ9LytyakqTzznDCVQjSXYG7NjbqOEgkQazQ3LSS9kBt+ssrebpzSogf+tLpgoHlQ0OOkml9dpBleko3vyoeWstuyIHM7sASoXX8atCuEzWlP6QIrXvnRTpoLOj9s2T9WjB/jw9NqJ5UiTdQYNzR1amDbj7uoO/bf6dps8AGW5MsowaInvYMdiIMAUiJ4upKeDpFXxDkIzPye4SHc77gRNSSluCamhjH3bEN2DsGn5rTacvCg7+hoKjzLpmHjKebJ7DqAZWiHijQGPFzA7RFGZmJ+mlXhsqs2NKs1615TEUUPNKLVnv2ZaSnH5XZCCMzL4ojxeVJFsQXmnJLKwBC8UNII3ekhHQjhcOcW2B3N6Sod0GFs32K6yzXJLinBtW3ETc5xBRkOSeDS3SUgKh5EZZ2B19Oj1qUoTfOtUlSQTc4JIj/Do49T3tGNyDDoDKiuG0Ekl3kqPsVa0x066pPDvK0Jq4Uhp1Ux7Hi70s/KL+mKqyuoCkrpFME/E9RbiTC9CXUWvQkaXQDTjaOTDDWuUMcjaztqFuCl9YCgPVMVI3dUOLCJxtAbIayh5sjz44srY6D57x4XU5A+KM98qgpMg+/uN2OifNWAei+Szdbgf8HJflMdzCpK6/ImCV7FOvoK/1U52neWXpfqwKF9jOYLdYQzYYOfBpfkaKHYWNliva5ZiHdy9Hi4oykMhqSfnZ1RuCFdnGNXaU84oijd/Bp8AaNPu2VrxAOgqGgLb0deygNj6in8GD5tGOjGFnbK6AP8fhl9sjyHuuQUOwpH21ZbqhL9TASIqa3hYrUCoxDiKCPZltd3gPB4QrAwmWms7u+NHcgbGCNGRzmCh6h7joF5cGRSw6b7FN5Y1COiRasmZpA0OOQmHtciUXbUOSUAQzJHdZd5mVUNLc4C3R3whXUZUdtCnyUprwNrIyZ+Jm1MccECmO5R3ZWhZqk9Y9FBfJYn5KkLSBNo6G5G7MT3B62wz8jmNoCLsPX/fDRwosKMToJI8P8Py/Go4cs3NxO1JozYN6LdDp7utjzgvxF6RDfp1uz/l0XzZm+doqGl7JOQokkTVr94P6WwGcjdULsmK9wl3nVR0amWPWC2nZBKpDez2X8TJMV/9WENA63uSWWk7XYRuCie6GFQwjE+DLyae9/h0ua6gXVqlL2xjcSjTQSuddp/qkEgH0Mnsoz1Tkp1S6U3nIMKg0Q0VW+/3oK3SIzHeVhQm8zrZVooikfEsZTKIpwooMYv0C0qNfCpunLekXb3IJQd4lhyuFFKf0gEev9H36lTzMtgOQzLJ7YLlc8LHtnACS1+TB/BXvK2lRjqgG96MkfXwH6YyI82aCca2W3EvGoIvvtXvdhlMUaLcw/bQlkxWClxrUZltGe6VPkZ/kPA9DkO4EhmFB5t0T4yQOlH1RbU7u6LO72m/oaUHDFdm+uuH4pqvTePfyUImN7M4IZHdJoc4N2k8i9n45LBWmOdfHzEEyR7MhO/uOVX5IvZHqUBtUzCnuICvVkrmeDW0Z7p7A9zMowjYg6VqTfb075COgADXQF1qTEeEG9pyCi7YCik6m1L9ckrrum3P+pvmBxDBZ2x1MOtpb+es6zdGcbSuF0ErDSMHOPgJctGW2Dbw9PG6S1rYBf0FYyKGWQXIcN8S9HSlGLWwlqiRFQg/M8DaEUiWZgjVoXyzRTnghR39toAndCvsSG3KO1gb2haYJjOXNSQUqQVzLvYmJHSXMGyBb7ra0M0bkUGlSj68j8xgb4ul2279ObOncN4ciMpmSTY1r6EA9Q4fQ5T3ZAS+Y056ZVnlF5J5AWxKZcAqht6aFABiyKKzXsQJHGpeQ8G7JEu4yPOOZvS2ocbVkZlOhUt4LVG9yMlvuEdPlODtQRhrRioy2bs99MBAcHxv5aTSxb/6KdTAd9GteMLfbwCSCmn/4qNUAKCg9/4nj2ZMw0aIkxbo8UmoqYwcqimyANDyv7u/wPMADNtqd2bLRx/Dc57PFHUJ1IDxz3LL0ei329e7co8AAYxMSmUtxuH5CW2JHFrZ6UZIs5jVfHhZibe69JHsPHFAkZYedDmx8uQEldFPcPWjvgYJk3SNgwumz0imSgOt1ylt2dAJqsbNSNa2KnKW9LyIMSzt4RT051WEHe06JTkOblGxJftLioeKuahBvJFPFK60nXFRloVpJwnSS3u0afemqnHJM/D7afJTjVakyUaUFgIpsXXILTFbibcBXku3TDis5E6oDmU/a4X0ma/p9DorKtMP7TJWNgUtCu7lPf3C8GE44G7IB9cya/wR+OjNyUWFcKFkfWoHCajaIbrekYtNa63Nv3//lc5q81C7mjYHIXdA+vUNd+yA3JQ1IbVc9zOBjsyrD0xOqsRABc2xqshK2s9muzgmbfCdBmFF1ZxBq9qwB+Jhm59QENSKbqqjYxMcHlq4qqNywZHqPcrr4wsKPWLkmzwqo+KuuY0H2AHj0deTA/HnMWn+b/hHmavInobLNRknmh1KY2E9cyWOQ1XyPfqw/IfHjfgGS0KwH6HAj7kKOffsFGx95rH98lSO5PMj/kWwgD5lqsQicjg6cDvJ0OeitJpNcLWRZWM/PQ+6U8wQmCO8XZC3KYH65XSH3wDpxK+51SgJCMC+XelGw4ayD1lm9yRxWAcEjWSdeYYfrWuYO4MAMkuxQD5cY+5GjHkLBppM/ggkGHVBGepLVvsJIm2IULQLRtCcVnldIH+AEDRwNzGur2YBsR4smP5WQmGY9KoeWmi+blWD0SUqtR3ucluXXNPuQbgnNBMxcYQfgrqCmOzWABKsuc1TdrvnGioNOUnmC5M8hdYV/ydAJF2CCXSY5IRvmVmIM8cBysn6Yw9uyofFllMFkEVaBwyNqR1uABw2/ZN/Phhf5nU0JNRTWYXdgr8fO5N8L1Mk7vQTTTvsKs/OlVq82oDdaZhF74H3nSsAxsBJcJGtl+TE+nFs8XqK4rrShZ8PuP+/CSuNLuAHh9mJ9FwEMWKyFTfUddIjimETL5qXdDyTqRFZ1iFSr80gJwZrCvsdSKfAFSVOK54p0QI1uyUafDWcP1DDXCRciqTxpx9BhOd7Sa0WRo1f6SMYGQ86bgOAU7rGGZDMtf0N6rrQ2tSHZpw5j+GdwcdmQ7P8D1mJBtvY4zL9fw/w7iQiTkOjqktc52CCAsgdWkA3NPFZUk7X3h9aq3I1K2hmPGavR1j00G6vWQcYvdR/hHUoit3ABNN2haUDa1+f0wJVCUo+9nVaJAUxcQtNAS7bTLa9zqK9T2I1Sk9718/T2Fk4e64AZ3JLk52cMA8Us7WXR2QDONeYe1kEnhmu4kwFnjUzRuo0XeBqlbTKrSYO3wYSnApSLuS1xAGHZBPq2VcmIzGtvoH/olrWBHZmCSGD+qWfWxnpkFgF/AWXewPuV8tT3vnloEhooYddkMu15Wn4kSiqFLRewiTmPFUaPpa3YNmQo74FWkxCWxgrL/KtIvoMvW7pvMCRmudjsLTt8ai0WXcZwlDsUL3uSy+OxtmzQcPGCc/8ETF3LTSSDWw8SMtI76E7v5fwVGRnVeMyUtFsHisIZmQJbpwuF2j09yAJlpF/gO3CCtusaZqmVZJYnKhfYSZ9S8itEWqHS2abyNype2wifqxFycXOUDiuxe7V69NpyXKlKcK3VrlrFcZvu6G/QP5lh92JCelI5f33erectcJgrS11np72scEv69oU57mRp1oXQIrKWGvoJ1jgjVSkcppEB+hgvlyGop8HoAJIZ+5wuI/KeGjhsjSozt2Tl/Tm9u9A3TVixBZ2S/dQrXtyiDbWXlqzmb2DD9RqQvTpgIHWkf7ujpbggELa1ZN1V8IIis2VFSizdyaHudexVdnQT6Z8q1dypSM71toYxOFSWnNhKlNzJQe+1o1YlrvJjyHelM1oq1l9a15Dgb1gmPtm1t2H5u3OlrUStsSUk1dkLXkFTvL7SknpbUvh+g0yX8C3NlORlbHDJKj5MX2jJcdwb3r/DPeTbuTcIdQQy8/+copp7BtEwbRV/DPePE2pSYWOsjNQiMwqJdGUFo1l1vFCj0+o6PWY9Sdd+TrG+XQ2xZ36Mp+/keBWsJ4ud0CX0lpJEL9PBdsI8jVVka8kxDCvatrej0LQHEkLGRhFBfayBMaW1uiMNSfffRzn6fylsJ7IHsBUJhU7coU7SZ70OGcpUvjzXP5XVwbKStVX6jSv5xkVBpphl9GTE+7IRSyvSDJ2IrXaNXhwqLaXakofKZKk8sUpHQlQqRll1R4aJNMPbavdBX+GaO3B6e3Iw/Y6ZSnPaCQ290rFISxwEpta+yY2nX0s+byXJsVp82Vq6nRrpZGgK+RvdCnlzBM86sVmNSXdI9MuAXGdgyOPhnuLi/pXHdA9edg00roosiL7uw3I+PYaP5ydaA1uxbUl18td9vYwx7rFl2pKsM77uf5JqraAeSlYXX/eduR9YqRYk6JtDxFrdm57ksNlfGN/voRIA9C80KpvdqdXoyUYB+zsJ0lwJfr7eMZ2e956kaMcHELqaZNfrdPJSyY25Boh5q45jf5SLOEu4/b5GHLHAYAUlbDInHqAuCVgoY5Nme4P1ovyBggGwO2SCq3xynXerFSq530pJ9qvmV0VWA7eV3KdfnsTt09en+Tda0dpaUQk8SOO8oYMfUtpYuiEZjK/n2QOlxsPblKw8+r5IvcYO0R8x2PK6WrXc+z+q5U3WcmM0op3byPtv9FrsWQsF65/e/gpoMzYv+6034uWIfB4vyDDanFslcWDzvcU6H3+8jsHbtr6pTIfWvnh53XKcZVR5IVmkUi4wnUVey9VZy26v5WvVjWajOvkAhfxBLlP91u1hTVTBzHwm8ljik0ffyVoQkiu2Q0pz9MWPL5hPy2v23WBYNLYXVaXvR70yHeTekd9x5wwEQtfWJnN3YUTJtZoy4t+UMqGnLvS4HGMt5ADWek12ZIjoe5fDaLOHD5GRBd20OhHo45SH+6VTxg/x1V483yIjhVV82i9Iq9mfa46TQnLcVkCvJBIIYrZQRG7JpNqKlqBDtCCd3JI5ll+n8enrTzcv+xEaaZCCLUiqz6/TjMkB4EjrfHm3QhIvIjSVtlzZyiS8VgKyTqKjTkZR9HoKM53GUhxD8jSaqo5uGrGCLhpVwUCyNL0t2Dkez6D0VoNCQ0WmGza4qEpQQ4djRYYWv+bxGapSQvWDlMH75/NW/IXMHuuTNmS8tielkiOSO2BkM1Sh//7P/3iMD6+77v6j//rv//mf/wW0pSdZ"; \ No newline at end of file diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.AbstractBeccaEntity.html b/docs/backend_api/classes/Backend_Script_API._internal_.AbstractBeccaEntity.html index 8c5a31cef..d8545f710 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.AbstractBeccaEntity.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.AbstractBeccaEntity.html @@ -1,5 +1,5 @@ AbstractBeccaEntity | trilium
trilium
    Preparing search index...

    Class AbstractBeccaEntity<T>Abstract

    Base class for all backend entities.

    -

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor +

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    blobId? dateCreated? dateModified? @@ -23,7 +23,7 @@ putEntityChange save updateFromRow -

    Constructors

    Properties

    blobId?: string
    dateCreated?: string
    dateModified?: string
    isProtected?: boolean
    isSynced?: boolean
    utcDateCreated: string
    utcDateModified?: string

    Accessors

    Methods

    Protected_getContent

    Protected_setContent

    • Mark the entity as (soft) deleted. It will be completely erased later.

      +

    Constructors

    Properties

    blobId?: string
    dateCreated?: string
    dateModified?: string
    isProtected?: boolean
    isSynced?: boolean
    utcDateCreated: string
    utcDateModified?: string

    Accessors

    Methods

    Protected_getContent

    Protected_setContent

    • Mark the entity as (soft) deleted. It will be completely erased later.

      This is a low-level method, for notes and branches use note.deleteNote() and 'branch.deleteBranch()` instead.

      -

      Parameters

      • deleteId: null | string = null

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.AsyncResource.html b/docs/backend_api/classes/Backend_Script_API._internal_.AsyncResource.html index f75cb9fab..b57596dc0 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.AsyncResource.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.AsyncResource.html @@ -6,7 +6,7 @@ own resources.

    import { AsyncResource, executionAsyncId } from 'node:async_hooks';

    // AsyncResource() is meant to be extended. Instantiating a
    // new AsyncResource() also triggers init. If triggerAsyncId is omitted then
    // async_hook.executionAsyncId() is used.
    const asyncResource = new AsyncResource(
      type, { triggerAsyncId: executionAsyncId(), requireManualDestroy: false },
    );

    // Run a function in the execution context of the resource. This will
    // * establish the context of the resource
    // * trigger the AsyncHooks before callbacks
    // * call the provided function `fn` with the supplied arguments
    // * trigger the AsyncHooks after callbacks
    // * restore the original execution context
    asyncResource.runInAsyncScope(fn, thisArg, ...args);

    // Call AsyncHooks destroy callbacks.
    asyncResource.emitDestroy();

    // Return the unique ID assigned to the AsyncResource instance.
    asyncResource.asyncId();

    // Return the trigger ID for the AsyncResource instance.
    asyncResource.triggerAsyncId();
    -

    Hierarchy (View Summary)

    Index

    Constructors

    constructor +

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    asyncId bind emitDestroy diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.Axios.html b/docs/backend_api/classes/Backend_Script_API._internal_.Axios.html index f58babc74..a583119fe 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.Axios.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.Axios.html @@ -1,4 +1,4 @@ -Axios | trilium
    trilium
      Preparing search index...

      Class Axios

      Hierarchy (View Summary)

      Index

      Constructors

      constructor +Axios | trilium
      trilium
        Preparing search index...

        Class Axios

        Hierarchy (View Summary)

        Index

        Constructors

        constructor

        Properties

        defaults interceptors

        Methods

        delete diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.AxiosError.html b/docs/backend_api/classes/Backend_Script_API._internal_.AxiosError.html index a2f202a35..6bfe16b1c 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.AxiosError.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.AxiosError.html @@ -1,4 +1,4 @@ -AxiosError | trilium
        trilium
          Preparing search index...

          Class AxiosError<T, D>

          Type Parameters

          • T = unknown
          • D = any

          Hierarchy (View Summary)

          Index

          Constructors

          constructor +AxiosError | trilium
          trilium
            Preparing search index...

            Class AxiosError<T, D>

            Type Parameters

            • T = unknown
            • D = any

            Hierarchy (View Summary)

            Index

            Constructors

            constructor

            Properties

            cause? code? config? diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.BAttachment.html b/docs/backend_api/classes/Backend_Script_API._internal_.BAttachment.html index cc551385e..c4b0b7638 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.BAttachment.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.BAttachment.html @@ -1,6 +1,6 @@ BAttachment | trilium
            trilium
              Preparing search index...

              Class BAttachment

              Attachment represent data related/attached to the note. Conceptually similar to attributes, but intended for larger amounts of data and generally not accessible to the user.

              -

              Hierarchy (View Summary)

              Index

              Constructors

              constructor +

              Hierarchy (View Summary)

              Index

              Constructors

              constructor

              Properties

              attachmentId? blobId? contentLength? @@ -47,10 +47,10 @@ larger amounts of data and generally not accessible to the user.

              save setContent updateFromRow -

              Constructors

              Properties

              attachmentId?: string
              blobId?: string
              contentLength?: number

              optionally added to the entity

              -
              dateCreated?: string
              dateModified?: string
              isDecrypted?: boolean
              isProtected?: boolean
              isSynced?: boolean
              mime: string
              noteId?: number
              ownerId: string

              either noteId or revisionId to which this attachment belongs

              -
              position?: number
              role: string
              title: string
              type?: "image" | "file"
              utcDateCreated: string
              utcDateModified?: string
              utcDateScheduledForErasureSince?: null | string

              Accessors

              Methods

              Protected_getContent

              Protected_setContent

              • Returns {
                    attachmentId: undefined | string;
                    blobId: undefined | string;
                    contentLength: undefined | number;
                    dateModified: undefined | string;
                    isDeleted: boolean;
                    isProtected: boolean;
                    mime: string;
                    ownerId: string;
                    position: undefined | number;
                    role: string;
                    title: undefined | string;
                    utcDateModified: undefined | string;
                    utcDateScheduledForErasureSince: undefined | null | string;
                }

              • Returns {
                    attachmentId: undefined | string;
                    blobId: undefined | string;
                    contentLength: undefined | number;
                    dateModified: undefined | string;
                    isDeleted: boolean;
                    isProtected: boolean;
                    mime: string;
                    ownerId: string;
                    position: undefined | number;
                    role: string;
                    title: undefined | string;
                    utcDateModified: undefined | string;
                    utcDateScheduledForErasureSince: undefined | null | string;
                }

              • Mark the entity as (soft) deleted. It will be completely erased later.

                +

              Constructors

              Properties

              attachmentId?: string
              blobId?: string
              contentLength?: number

              optionally added to the entity

              +
              dateCreated?: string
              dateModified?: string
              isDecrypted?: boolean
              isProtected?: boolean
              isSynced?: boolean
              mime: string
              noteId?: number
              ownerId: string

              either noteId or revisionId to which this attachment belongs

              +
              position?: number
              role: string
              title: string
              type?: "image" | "file"
              utcDateCreated: string
              utcDateModified?: string
              utcDateScheduledForErasureSince?: null | string

              Accessors

              Methods

              Protected_getContent

              Protected_setContent

              • Returns {
                    attachmentId: undefined | string;
                    blobId: undefined | string;
                    contentLength: undefined | number;
                    dateModified: undefined | string;
                    isDeleted: boolean;
                    isProtected: boolean;
                    mime: string;
                    ownerId: string;
                    position: undefined | number;
                    role: string;
                    title: undefined | string;
                    utcDateModified: undefined | string;
                    utcDateScheduledForErasureSince: undefined | null | string;
                }

              • Returns {
                    attachmentId: undefined | string;
                    blobId: undefined | string;
                    contentLength: undefined | number;
                    dateModified: undefined | string;
                    isDeleted: boolean;
                    isProtected: boolean;
                    mime: string;
                    ownerId: string;
                    position: undefined | number;
                    role: string;
                    title: undefined | string;
                    utcDateModified: undefined | string;
                    utcDateScheduledForErasureSince: undefined | null | string;
                }

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Accessors
              Methods
              +

              Parameters

              • deleteId: null | string = null

              Returns void

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Accessors
              Methods
              diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.BAttribute.html b/docs/backend_api/classes/Backend_Script_API._internal_.BAttribute.html index 84baa94f8..068f1e3ad 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.BAttribute.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.BAttribute.html @@ -1,6 +1,6 @@ BAttribute | trilium
              trilium
                Preparing search index...

                Class BAttribute

                Attribute is an abstract concept which has two real uses - label (key - value pair) and relation (representing named relationship between source and target note)

                -

                Hierarchy (View Summary)

                Index

                Constructors

                constructor +

                Hierarchy (View Summary)

                Index

                Constructors

                constructor

                Properties

                attributeId blobId? dateCreated? @@ -47,7 +47,7 @@ and relation (representing named relationship between source and target note)

                update updateFromRow validate -

                Constructors

                Properties

                attributeId: string
                blobId?: string
                dateCreated?: string
                dateModified?: string
                isInheritable: boolean
                isProtected?: boolean
                isSynced?: boolean
                name: string
                noteId: string
                position: number
                type: AttributeType
                utcDateCreated: string
                utcDateModified?: string
                value: string

                Accessors

                Methods

                Protected_getContent

                Protected_setContent

                • Returns {
                      attributeId: string;
                      isDeleted: boolean;
                      isInheritable: boolean;
                      name: string;
                      noteId: string;
                      position: number;
                      type: AttributeType;
                      utcDateModified: undefined | string;
                      value: string;
                  }

                • Mark the entity as (soft) deleted. It will be completely erased later.

                  +

                Constructors

                Properties

                attributeId: string
                blobId?: string
                dateCreated?: string
                dateModified?: string
                isInheritable: boolean
                isProtected?: boolean
                isSynced?: boolean
                name: string
                noteId: string
                position: number
                type: AttributeType
                utcDateCreated: string
                utcDateModified?: string
                value: string

                Accessors

                Methods

                Protected_getContent

                Protected_setContent

                • Returns {
                      attributeId: string;
                      isDeleted: boolean;
                      isInheritable: boolean;
                      name: string;
                      noteId: string;
                      position: number;
                      type: AttributeType;
                      utcDateModified: undefined | string;
                      value: string;
                  }

                Settings

                Member Visibility

                On This Page

                Constructors
                Properties
                Accessors
                Methods
                +

                Parameters

                • deleteId: null | string = null

                Returns void

                Settings

                Member Visibility

                On This Page

                Constructors
                Properties
                Accessors
                Methods
                diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.BBranch.html b/docs/backend_api/classes/Backend_Script_API._internal_.BBranch.html index 20d8488ee..11e717966 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.BBranch.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.BBranch.html @@ -2,7 +2,7 @@ parents.

                Note that you should not rely on the branch's identity, since it can change easily with a note's move. Always check noteId instead.

                -

                Hierarchy (View Summary)

                Index

                Constructors

                constructor +

                Hierarchy (View Summary)

                Index

                Constructors

                constructor

                Properties

                blobId? branchId? dateCreated? @@ -42,16 +42,16 @@ Always check noteId instead.

                save update updateFromRow -

                Constructors

                Properties

                blobId?: string
                branchId?: string
                dateCreated?: string
                dateModified?: string
                isExpanded: boolean
                isProtected?: boolean
                isSynced?: boolean
                noteId: string
                notePosition: number
                parentNoteId: string
                prefix: null | string
                utcDateCreated: string
                utcDateModified?: string

                Accessors

                • get isWeak(): boolean

                  Branch is weak when its existence should not hinder deletion of its note. +

                Constructors

                Properties

                blobId?: string
                branchId?: string
                dateCreated?: string
                dateModified?: string
                isExpanded: boolean
                isProtected?: boolean
                isSynced?: boolean
                noteId: string
                notePosition: number
                parentNoteId: string
                prefix: null | string
                utcDateCreated: string
                utcDateModified?: string

                Accessors

                • get isWeak(): boolean

                  Branch is weak when its existence should not hinder deletion of its note. As a result, note with only weak branches should be immediately deleted. An example is shared or bookmarked clones - they are created automatically and exist for technical reasons, not as user-intended actions. From user perspective, they don't count as real clones and for the purpose of deletion should not act as a clone.

                  -

                  Returns boolean

                Methods

                Protected_getContent

                Protected_setContent

                Methods

                Protected_getContent

                Protected_setContent

                • Delete a branch. If this is a last note's branch, delete the note as well.

                  Parameters

                  • OptionaldeleteId: string

                    optional delete identified

                  • OptionaltaskContext: TaskContext

                  Returns boolean

                  true if note has been deleted, false otherwise

                  -

                • Returns {
                      branchId: undefined | string;
                      isDeleted: boolean;
                      isExpanded: boolean;
                      noteId: string;
                      notePosition: number;
                      parentNoteId: string;
                      prefix: null | string;
                      utcDateModified: undefined | string;
                  }

                • Returns {
                      branchId: undefined | string;
                      isDeleted: boolean;
                      isExpanded: boolean;
                      noteId: string;
                      notePosition: number;
                      parentNoteId: string;
                      prefix: null | string;
                      utcDateModified: undefined | string;
                  }

                Settings

                Member Visibility

                On This Page

                Constructors
                Properties
                Accessors
                Methods
                +

                Parameters

                • deleteId: null | string = null

                Returns void

                Settings

                Member Visibility

                On This Page

                Constructors
                Properties
                Accessors
                Methods
                diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.BEtapiToken.html b/docs/backend_api/classes/Backend_Script_API._internal_.BEtapiToken.html index afd348fbc..d60989931 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.BEtapiToken.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.BEtapiToken.html @@ -6,7 +6,7 @@ Used by:

                The format user is presented with is "_". This is also called "authToken" to distinguish it from tokenHash and token.

                -

                Hierarchy (View Summary)

                Index

                Constructors

                constructor +

                Hierarchy (View Summary)

                Index

                Constructors

                constructor

                Properties

                blobId? dateCreated? dateModified? @@ -36,7 +36,7 @@ from tokenHash and token.

                putEntityChange save updateFromRow -

                Constructors

                Properties

                blobId?: string
                dateCreated?: string
                dateModified?: string
                etapiTokenId?: string
                isProtected?: boolean
                isSynced?: boolean
                name: string
                tokenHash: string
                utcDateCreated: string
                utcDateModified?: string

                Accessors

                Methods

                Protected_getContent

                Protected_setContent

                • Returns {
                      etapiTokenId: undefined | string;
                      isDeleted: boolean;
                      name: string;
                      tokenHash: string;
                      utcDateCreated: string;
                      utcDateModified: undefined | string;
                  }

                • Mark the entity as (soft) deleted. It will be completely erased later.

                  +

                Constructors

                Properties

                blobId?: string
                dateCreated?: string
                dateModified?: string
                etapiTokenId?: string
                isProtected?: boolean
                isSynced?: boolean
                name: string
                tokenHash: string
                utcDateCreated: string
                utcDateModified?: string

                Accessors

                Methods

                Protected_getContent

                Protected_setContent

                • Returns {
                      etapiTokenId: undefined | string;
                      isDeleted: boolean;
                      name: string;
                      tokenHash: string;
                      utcDateCreated: string;
                      utcDateModified: undefined | string;
                  }

                Settings

                Member Visibility

                On This Page

                Constructors
                Properties
                Accessors
                Methods
                +

                Parameters

                Returns void

                Settings

                Member Visibility

                On This Page

                Constructors
                Properties
                Accessors
                Methods
                diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.BNote.html b/docs/backend_api/classes/Backend_Script_API._internal_.BNote.html index 7709605bd..d5c2baa91 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.BNote.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.BNote.html @@ -1,5 +1,5 @@ BNote | trilium
                trilium
                  Preparing search index...

                  Class BNote

                  Trilium's main entity, which can represent text note, image, code note, file attachment etc.

                  -

                  Hierarchy (View Summary)

                  Index

                  Constructors

                  constructor +

                  Hierarchy (View Summary)

                  Index

                  Constructors

                  constructor

                  Properties

                  __flatTextCache blobId? children @@ -172,23 +172,23 @@ toggleRelation update updateFromRow -

                  Constructors

                  Properties

                  __flatTextCache

                  __flatTextCache: null | string
                  blobId?: string
                  children: BNote[]
                  contentAndAttachmentsAndRevisionsSize: null | number

                  size of the note content, attachment contents and revision contents in bytes

                  -
                  contentAndAttachmentsSize: null | number

                  size of the note content, attachment contents in bytes

                  -
                  contentSize: null | number

                  size of the content in bytes

                  -
                  dateCreated?: string
                  dateModified?: string
                  isBeingDeleted: boolean

                  set during the deletion operation, before it is completed (removed from becca completely).

                  -
                  isDecrypted: boolean
                  isProtected?: boolean
                  isSynced?: boolean
                  mime: string
                  noteId: string
                  ownedAttributes: BAttribute[]
                  parentBranches: BBranch[]
                  parents: BNote[]
                  revisionCount: null | number

                  number of note revisions for this note

                  -
                  targetRelations: BAttribute[]
                  title: string
                  type:
                      | "canvas"
                      | "code"
                      | "search"
                      | "image"
                      | "text"
                      | "file"
                      | "noteMap"
                      | "launcher"
                      | "doc"
                      | "contentWidget"
                      | "relationMap"
                      | "render"
                      | "mermaid"
                      | "book"
                      | "webView"
                      | "mindMap"
                      | "geoMap"
                  utcDateCreated: string
                  utcDateModified?: string

                  Accessors

                  Methods

                  __validateTypeName

                  • __validateTypeName(type?: null | string, name?: null | string): void

                    Parameters

                    • Optionaltype: null | string
                    • Optionalname: null | string

                    Returns void

                  Protected_getContent

                  Protected_setContent

                  • Adds a new attribute to this note. The attribute is saved and returned. +

                  Constructors

                  Properties

                  __flatTextCache

                  __flatTextCache: null | string
                  blobId?: string
                  children: BNote[]
                  contentAndAttachmentsAndRevisionsSize: null | number

                  size of the note content, attachment contents and revision contents in bytes

                  +
                  contentAndAttachmentsSize: null | number

                  size of the note content, attachment contents in bytes

                  +
                  contentSize: null | number

                  size of the content in bytes

                  +
                  dateCreated?: string
                  dateModified?: string
                  isBeingDeleted: boolean

                  set during the deletion operation, before it is completed (removed from becca completely).

                  +
                  isDecrypted: boolean
                  isProtected?: boolean
                  isSynced?: boolean
                  mime: string
                  noteId: string
                  ownedAttributes: BAttribute[]
                  parentBranches: BBranch[]
                  parents: BNote[]
                  revisionCount: null | number

                  number of note revisions for this note

                  +
                  targetRelations: BAttribute[]
                  title: string
                  type:
                      | "canvas"
                      | "code"
                      | "search"
                      | "image"
                      | "text"
                      | "file"
                      | "noteMap"
                      | "launcher"
                      | "doc"
                      | "contentWidget"
                      | "relationMap"
                      | "render"
                      | "mermaid"
                      | "book"
                      | "webView"
                      | "mindMap"
                      | "geoMap"
                  utcDateCreated: string
                  utcDateModified?: string

                  Accessors

                  Methods

                  __validateTypeName

                  • __validateTypeName(type?: null | string, name?: null | string): void

                    Parameters

                    • Optionaltype: null | string
                    • Optionalname: null | string

                    Returns void

                  Protected_getContent

                  Protected_setContent

                  • Adds a new attribute to this note. The attribute is saved and returned. See addLabel, addRelation for more specific methods.

                    Parameters

                    • type: AttributeType

                      attribute type (label / relation)

                    • name: string

                      name of the attribute, not including the leading ~/#

                    • value: string = ""

                      value of the attribute - text for labels, target note ID for relations; optional.

                      -
                    • isInheritable: boolean = false
                    • position: null | number = null

                    Returns BAttribute

                  • Adds a new label to this note. The label attribute is saved and returned.

                    +
                  • isInheritable: boolean = false
                  • position: null | number = null

                  Returns BAttribute

                  Returns BAttribute

                  Returns BAttribute

                  Returns void

                  Returns void

                  Returns void

                  Returns BAttachment

                  Returns void

                  Returns void

                  Returns void

                  Returns void

                  Returns void

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Properties
                  Accessors
                  Methods
                  __validateTypeName_getContent_setContentaddAttributeaddLabeladdRelationareAllNotePathsArchivedbeforeSavingcloneToconvertToParentAttachmentdecryptdeleteNoteeraseExcessRevisionSnapshotsgenerateHashgetAllNotePathsgetAncestorNoteIdsgetAncestorsgetAttachmentByIdgetAttachmentByTitlegetAttachmentsgetAttachmentsByRolegetAttributegetAttributeCaseInsensitivegetAttributesgetAttributeValuegetBestNotePathgetBestNotePathStringgetBranchesgetChildBranchesgetChildNotesgetContentgetDescendantNoteIdsgetDistanceToAncestorgetFileNamegetFilteredChildBranchesgetFlatTextgetIcongetInheritingNotesgetJsonContentgetJsonContentSafelygetLabelgetLabelDefinitionsgetLabelsgetLabelValuegetLabelValuesgetOwnedAttributegetOwnedAttributesgetOwnedAttributeValuegetOwnedLabelgetOwnedLabelsgetOwnedLabelValuegetOwnedLabelValuesgetOwnedRelationgetOwnedRelationsgetOwnedRelationValuegetParentBranchesgetParentNotesgetPojogetPojoToSavegetRelationgetRelationDefinitionsgetRelationsgetRelationTargetgetRelationValuegetRevisionsgetScriptEnvgetSearchResultNotesgetSortedNotePathRecordsgetStrongParentBranchesgetSubtreegetSubtreeNoteIdsgetSubtreeNotesIncludingTemplatedgetTargetRelationsgetTitleOrProtectedgetUtcDateChangedhasAncestorhasAttributehasChildrenhasInheritableArchivedLabelhasLabelhasOwnedAttributehasOwnedLabelhasOwnedRelationhasRelationhasStringContentinitinvalidateSubTreeinvalidateThisCacheisContentAvailableisDescendantOfNoteisEligibleForConversionToAttachmentisFolderisHiddenCompletelyisHtmlisImageisInheritedisInHiddenSubtreeisJavaScriptisJsonisLabelTruthyisLaunchBarConfigisOptionsisRootisStringNotemarkAsDeletedmarkAsDeletedSimpleputEntityChangeremoveAttributeremoveLabelremoveRelationsavesaveAttachmentsaveRevisionsearchNoteInSubtreesearchNotesInSubtreesetAttributesetContentsetJsonContentsetLabelsetRelationsortChildrensortParentstoggleAttributetoggleLabeltoggleRelationupdateupdateFromRow
                  +

                  Returns void

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Properties
                  Accessors
                  Methods
                  __validateTypeName_getContent_setContentaddAttributeaddLabeladdRelationareAllNotePathsArchivedbeforeSavingcloneToconvertToParentAttachmentdecryptdeleteNoteeraseExcessRevisionSnapshotsgenerateHashgetAllNotePathsgetAncestorNoteIdsgetAncestorsgetAttachmentByIdgetAttachmentByTitlegetAttachmentsgetAttachmentsByRolegetAttributegetAttributeCaseInsensitivegetAttributesgetAttributeValuegetBestNotePathgetBestNotePathStringgetBranchesgetChildBranchesgetChildNotesgetContentgetDescendantNoteIdsgetDistanceToAncestorgetFileNamegetFilteredChildBranchesgetFlatTextgetIcongetInheritingNotesgetJsonContentgetJsonContentSafelygetLabelgetLabelDefinitionsgetLabelsgetLabelValuegetLabelValuesgetOwnedAttributegetOwnedAttributesgetOwnedAttributeValuegetOwnedLabelgetOwnedLabelsgetOwnedLabelValuegetOwnedLabelValuesgetOwnedRelationgetOwnedRelationsgetOwnedRelationValuegetParentBranchesgetParentNotesgetPojogetPojoToSavegetRelationgetRelationDefinitionsgetRelationsgetRelationTargetgetRelationValuegetRevisionsgetScriptEnvgetSearchResultNotesgetSortedNotePathRecordsgetStrongParentBranchesgetSubtreegetSubtreeNoteIdsgetSubtreeNotesIncludingTemplatedgetTargetRelationsgetTitleOrProtectedgetUtcDateChangedhasAncestorhasAttributehasChildrenhasInheritableArchivedLabelhasLabelhasOwnedAttributehasOwnedLabelhasOwnedRelationhasRelationhasStringContentinitinvalidateSubTreeinvalidateThisCacheisContentAvailableisDescendantOfNoteisEligibleForConversionToAttachmentisFolderisHiddenCompletelyisHtmlisImageisInheritedisInHiddenSubtreeisJavaScriptisJsonisLabelTruthyisLaunchBarConfigisOptionsisRootisStringNotemarkAsDeletedmarkAsDeletedSimpleputEntityChangeremoveAttributeremoveLabelremoveRelationsavesaveAttachmentsaveRevisionsearchNoteInSubtreesearchNotesInSubtreesetAttributesetContentsetJsonContentsetLabelsetRelationsortChildrensortParentstoggleAttributetoggleLabeltoggleRelationupdateupdateFromRow
                  diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.BOption.html b/docs/backend_api/classes/Backend_Script_API._internal_.BOption.html index 84f23fbe6..c6b6d4246 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.BOption.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.BOption.html @@ -1,5 +1,5 @@ BOption | trilium
                  trilium
                    Preparing search index...

                    Class BOption

                    Option represents a name-value pair, either directly configurable by the user or some system property.

                    -

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor +

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor

                    Properties

                    blobId? dateCreated? dateModified? @@ -28,7 +28,7 @@ putEntityChange save updateFromRow -

                    Constructors

                    Properties

                    blobId?: string
                    dateCreated?: string
                    dateModified?: string
                    isProtected?: boolean
                    isSynced?: boolean
                    name: string
                    utcDateCreated: string
                    utcDateModified?: string
                    value: string

                    Accessors

                    Methods

                    Protected_getContent

                    Protected_setContent

                    • Returns {
                          isSynced: undefined | boolean;
                          name: string;
                          utcDateModified: undefined | string;
                          value: string;
                      }

                    • Mark the entity as (soft) deleted. It will be completely erased later.

                      +

                    Constructors

                    Properties

                    blobId?: string
                    dateCreated?: string
                    dateModified?: string
                    isProtected?: boolean
                    isSynced?: boolean
                    name: string
                    utcDateCreated: string
                    utcDateModified?: string
                    value: string

                    Accessors

                    Methods

                    Protected_getContent

                    Protected_setContent

                    • Returns {
                          isSynced: undefined | boolean;
                          name: string;
                          utcDateModified: undefined | string;
                          value: string;
                      }

                    Settings

                    Member Visibility

                    On This Page

                    Constructors
                    Properties
                    Accessors
                    Methods
                    +

                    Parameters

                    Returns void

                    Settings

                    Member Visibility

                    On This Page

                    Constructors
                    Properties
                    Accessors
                    Methods
                    diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.BRevision.html b/docs/backend_api/classes/Backend_Script_API._internal_.BRevision.html index b46cc5f2a..bb1eea714 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.BRevision.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.BRevision.html @@ -1,6 +1,6 @@ BRevision | trilium
                    trilium
                      Preparing search index...

                      Class BRevision

                      Revision represents a snapshot of note's title and content at some point in the past. It's used for seamless note versioning.

                      -

                      Hierarchy (View Summary)

                      Index

                      Constructors

                      constructor +

                      Hierarchy (View Summary)

                      Index

                      Constructors

                      constructor

                      Properties

                      blobId? content? contentLength? @@ -47,11 +47,11 @@ It's used for seamless note versioning.

                      save setContent updateFromRow -

                      Constructors

                      Properties

                      blobId?: string

                      Optionalcontent

                      content?: string | Buffer<ArrayBufferLike>
                      contentLength?: number
                      dateCreated?: string
                      dateLastEdited?: string
                      dateModified?: string
                      isProtected?: boolean
                      isSynced?: boolean
                      mime: string
                      noteId: string
                      revisionId?: string
                      title: string
                      type:
                          | "canvas"
                          | "code"
                          | "search"
                          | "image"
                          | "text"
                          | "file"
                          | "noteMap"
                          | "launcher"
                          | "doc"
                          | "contentWidget"
                          | "relationMap"
                          | "render"
                          | "mermaid"
                          | "book"
                          | "webView"
                          | "mindMap"
                          | "geoMap"
                      utcDateCreated: string
                      utcDateLastEdited?: string
                      utcDateModified?: string

                      Accessors

                      Methods

                      Protected_getContent

                      Protected_setContent

                      • Returns {
                            blobId: undefined | string;
                            content: undefined | string | Buffer<ArrayBufferLike>;
                            contentLength: undefined | number;
                            dateCreated: undefined | string;
                            dateLastEdited: undefined | string;
                            isProtected: undefined | boolean;
                            mime: string;
                            noteId: string;
                            revisionId: undefined | string;
                            title: undefined | string;
                            type:
                                | "canvas"
                                | "code"
                                | "search"
                                | "image"
                                | "text"
                                | "file"
                                | "noteMap"
                                | "launcher"
                                | "doc"
                                | "contentWidget"
                                | "relationMap"
                                | "render"
                                | "mermaid"
                                | "book"
                                | "webView"
                                | "mindMap"
                                | "geoMap";
                            utcDateCreated: string;
                            utcDateLastEdited: undefined
                            | string;
                            utcDateModified: undefined | string;
                        }

                      • Returns {
                            blobId: undefined | string;
                            content: undefined | string | Buffer<ArrayBufferLike>;
                            contentLength: undefined | number;
                            dateCreated: undefined | string;
                            dateLastEdited: undefined | string;
                            isProtected: undefined | boolean;
                            mime: string;
                            noteId: string;
                            revisionId: undefined | string;
                            title: undefined | string;
                            type:
                                | "canvas"
                                | "code"
                                | "search"
                                | "image"
                                | "text"
                                | "file"
                                | "noteMap"
                                | "launcher"
                                | "doc"
                                | "contentWidget"
                                | "relationMap"
                                | "render"
                                | "mermaid"
                                | "book"
                                | "webView"
                                | "mindMap"
                                | "geoMap";
                            utcDateCreated: string;
                            utcDateLastEdited: undefined
                            | string;
                            utcDateModified: undefined | string;
                        }

                      • Mark the entity as (soft) deleted. It will be completely erased later.

                        +

                      Constructors

                      Properties

                      blobId?: string

                      Optionalcontent

                      content?: string | Buffer<ArrayBufferLike>
                      contentLength?: number
                      dateCreated?: string
                      dateLastEdited?: string
                      dateModified?: string
                      isProtected?: boolean
                      isSynced?: boolean
                      mime: string
                      noteId: string
                      revisionId?: string
                      title: string
                      type:
                          | "canvas"
                          | "code"
                          | "search"
                          | "image"
                          | "text"
                          | "file"
                          | "noteMap"
                          | "launcher"
                          | "doc"
                          | "contentWidget"
                          | "relationMap"
                          | "render"
                          | "mermaid"
                          | "book"
                          | "webView"
                          | "mindMap"
                          | "geoMap"
                      utcDateCreated: string
                      utcDateLastEdited?: string
                      utcDateModified?: string

                      Accessors

                      Methods

                      Protected_getContent

                      Protected_setContent

                      • Returns {
                            blobId: undefined | string;
                            content: undefined | string | Buffer<ArrayBufferLike>;
                            contentLength: undefined | number;
                            dateCreated: undefined | string;
                            dateLastEdited: undefined | string;
                            isProtected: undefined | boolean;
                            mime: string;
                            noteId: string;
                            revisionId: undefined | string;
                            title: undefined | string;
                            type:
                                | "canvas"
                                | "code"
                                | "search"
                                | "image"
                                | "text"
                                | "file"
                                | "noteMap"
                                | "launcher"
                                | "doc"
                                | "contentWidget"
                                | "relationMap"
                                | "render"
                                | "mermaid"
                                | "book"
                                | "webView"
                                | "mindMap"
                                | "geoMap";
                            utcDateCreated: string;
                            utcDateLastEdited: undefined
                            | string;
                            utcDateModified: undefined | string;
                        }

                      • Returns {
                            blobId: undefined | string;
                            content: undefined | string | Buffer<ArrayBufferLike>;
                            contentLength: undefined | number;
                            dateCreated: undefined | string;
                            dateLastEdited: undefined | string;
                            isProtected: undefined | boolean;
                            mime: string;
                            noteId: string;
                            revisionId: undefined | string;
                            title: undefined | string;
                            type:
                                | "canvas"
                                | "code"
                                | "search"
                                | "image"
                                | "text"
                                | "file"
                                | "noteMap"
                                | "launcher"
                                | "doc"
                                | "contentWidget"
                                | "relationMap"
                                | "render"
                                | "mermaid"
                                | "book"
                                | "webView"
                                | "mindMap"
                                | "geoMap";
                            utcDateCreated: string;
                            utcDateLastEdited: undefined
                            | string;
                            utcDateModified: undefined | string;
                        }

                      Settings

                      Member Visibility

                      On This Page

                      Constructors
                      Properties
                      Accessors
                      Methods
                      +

                      Parameters

                      Returns void

                      Settings

                      Member Visibility

                      On This Page

                      Constructors
                      Properties
                      Accessors
                      Methods
                      diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.CanceledError.html b/docs/backend_api/classes/Backend_Script_API._internal_.CanceledError.html index c7883d886..c1addaf43 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.CanceledError.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.CanceledError.html @@ -1,4 +1,4 @@ -CanceledError | trilium
                      trilium
                        Preparing search index...

                        Class CanceledError<T>

                        Type Parameters

                        • T

                        Hierarchy (View Summary)

                        Index

                        Constructors

                        constructor +CanceledError | trilium
                        trilium
                          Preparing search index...

                          Class CanceledError<T>

                          Type Parameters

                          • T

                          Hierarchy (View Summary)

                          Index

                          Constructors

                          constructor

                          Properties

                          cause? code? config? diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResource.html b/docs/backend_api/classes/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResource.html index 4384d4851..0763ff093 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResource.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResource.html @@ -7,7 +7,7 @@ of events.EventEmitterAsyncResource will run within its async

                          The EventEmitterAsyncResource class has the same methods and takes the same options as EventEmitter and AsyncResource themselves.

                          v17.4.0, v16.14.0

                          -

                          Hierarchy (View Summary)

                          Index

                          Constructors

                          constructor +

                          Hierarchy (View Summary)

                          Index

                          Constructors

                          constructor

                          Properties

                          asyncId asyncResource triggerAsyncId diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.EventEmitter.html b/docs/backend_api/classes/Backend_Script_API._internal_.EventEmitter.html index ec8275edf..9db2aff7b 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.EventEmitter.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.EventEmitter.html @@ -6,7 +6,7 @@ added and 'removeListener' when existing listeners are removed.

                          It supports the following option:

                          v0.1.26

                          -

                          Type Parameters

                          Hierarchy (View Summary)

                          Index

                          Constructors

                          constructor +

                          Type Parameters

                          Hierarchy (View Summary)

                          Index

                          Constructors

                          constructor

                          Properties

                          captureRejections captureRejectionSymbol defaultMaxListeners diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.SpacedUpdate.html b/docs/backend_api/classes/Backend_Script_API._internal_.SpacedUpdate.html index e20fb3cff..9b0a58b35 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.SpacedUpdate.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.SpacedUpdate.html @@ -1,7 +1,7 @@ -SpacedUpdate | trilium
                          trilium
                            Preparing search index...

                            Class SpacedUpdate

                            Index

                            Constructors

                            constructor +SpacedUpdate | trilium
                            trilium
                              Preparing search index...

                              Class SpacedUpdate

                              Index

                              Constructors

                              constructor

                              Methods

                              allowUpdateWithoutChange isAllSavedAndTriggerUpdate scheduleUpdate triggerUpdate updateNowIfNecessary -

                              Constructors

                              Methods

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Methods
                              +

                              Constructors

                              Methods

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Methods
                              diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.TaskContext.html b/docs/backend_api/classes/Backend_Script_API._internal_.TaskContext.html index f40c5d412..fe9698317 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.TaskContext.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.TaskContext.html @@ -1,8 +1,8 @@ -TaskContext | trilium
                              trilium
                                Preparing search index...

                                Class TaskContext

                                Index

                                Constructors

                                constructor +TaskContext | trilium
                                trilium
                                  Preparing search index...

                                  Class TaskContext

                                  Index

                                  Constructors

                                  constructor

                                  Properties

                                  data noteDeletionHandlerTriggered

                                  Methods

                                  increaseProgressCount reportError taskSucceeded getInstance -

                                  Constructors

                                  Properties

                                  data: null | TaskData
                                  noteDeletionHandlerTriggered: boolean

                                  Methods

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Constructors
                                  Properties
                                  Methods
                                  +

                                  Constructors

                                  Properties

                                  data: null | TaskData
                                  noteDeletionHandlerTriggered: boolean

                                  Methods

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Constructors
                                  Properties
                                  Methods
                                  diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.default.html b/docs/backend_api/classes/Backend_Script_API._internal_.default.html index ef947f52d..3a3d898cb 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.default.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.default.html @@ -1,6 +1,6 @@ default | trilium
                                  trilium
                                    Preparing search index...

                                    Class default

                                    Becca is a backend cache of all notes, branches, and attributes. There's a similar frontend cache Froca, and share cache Shaca.

                                    -
                                    Index

                                    Constructors

                                    constructor +
                                    Index

                                    Constructors

                                    constructor

                                    Properties

                                    allNoteSetCache attributeIndex attributes @@ -38,6 +38,6 @@ There's a similar frontend cache Froca, and share cache Shaca.

                                    getRevisionsFromQuery getRoot reset -

                                    Constructors

                                    Properties

                                    allNoteSetCache: null | NoteSet
                                    attributeIndex: Record<string, BAttribute[]>

                                    Points from attribute type-name to list of attributes

                                    -
                                    attributes: Record<string, BAttribute>
                                    branches: Record<string, BBranch>
                                    childParentToBranch: Record<string, BBranch>
                                    etapiTokens: Record<string, BEtapiToken>
                                    loaded: boolean
                                    notes: Record<string, BNote>
                                    options: Record<string, BOption>

                                    Methods

                                    • Should be called when the set of all non-skeleton notes changes (added/removed)

                                      -

                                      Returns void

                                    • Parameters

                                      • query: string
                                      • params: string[] = []

                                      Returns BRecentNote[]

                                    Settings

                                    Member Visibility

                                    On This Page

                                    Constructors
                                    Properties
                                    Methods
                                    +

                                    Constructors

                                    Properties

                                    allNoteSetCache: null | NoteSet
                                    attributeIndex: Record<string, BAttribute[]>

                                    Points from attribute type-name to list of attributes

                                    +
                                    attributes: Record<string, BAttribute>
                                    branches: Record<string, BBranch>
                                    childParentToBranch: Record<string, BBranch>
                                    etapiTokens: Record<string, BEtapiToken>
                                    loaded: boolean
                                    notes: Record<string, BNote>
                                    options: Record<string, BOption>

                                    Methods

                                    • Should be called when the set of all non-skeleton notes changes (added/removed)

                                      +

                                      Returns void

                                    • Parameters

                                      • query: string
                                      • params: string[] = []

                                      Returns BRecentNote[]

                                    Settings

                                    Member Visibility

                                    On This Page

                                    Constructors
                                    Properties
                                    Methods
                                    diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.node_modules__types_xml2js.Parser.html b/docs/backend_api/classes/Backend_Script_API._internal_.node_modules__types_xml2js.Parser.html index 40eecb6bb..824f2bace 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.node_modules__types_xml2js.Parser.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.node_modules__types_xml2js.Parser.html @@ -6,7 +6,7 @@ added and 'removeListener' when existing listeners are removed.

                                    It supports the following option:

                                    v0.1.26

                                    -

                                    Hierarchy (View Summary)

                                    Index

                                    Constructors

                                    constructor +

                                    Hierarchy (View Summary)

                                    Index

                                    Constructors

                                    constructor

                                    Properties

                                    captureRejections captureRejectionSymbol defaultMaxListeners diff --git a/docs/backend_api/classes/Backend_Script_API._internal_.node_modules__types_xml2js.ValidationError.html b/docs/backend_api/classes/Backend_Script_API._internal_.node_modules__types_xml2js.ValidationError.html index b4d1cc154..07c0415f4 100644 --- a/docs/backend_api/classes/Backend_Script_API._internal_.node_modules__types_xml2js.ValidationError.html +++ b/docs/backend_api/classes/Backend_Script_API._internal_.node_modules__types_xml2js.ValidationError.html @@ -1,4 +1,4 @@ -ValidationError | trilium
                                    trilium
                                      Preparing search index...

                                      Class ValidationError

                                      Hierarchy

                                      • Error
                                        • ValidationError
                                      Index

                                      Constructors

                                      constructor +ValidationError | trilium
                                      trilium
                                        Preparing search index...

                                        Class ValidationError

                                        Hierarchy

                                        • Error
                                          • ValidationError
                                        Index

                                        Constructors

                                        constructor

                                        Properties

                                        cause? message name diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.FAttachment.html b/docs/backend_api/classes/Frontend_Script_API._internal_.FAttachment.html new file mode 100644 index 000000000..7d8e71360 --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.FAttachment.html @@ -0,0 +1,17 @@ +FAttachment | trilium
                                        trilium
                                          Preparing search index...

                                          Class FAttachment

                                          Attachment is a file directly tied into a note without +being a hidden child.

                                          +
                                          Index

                                          Constructors

                                          constructor +

                                          Properties

                                          attachmentId +contentLength +isProtected +mime +ownerId +role +title +utcDateModified +utcDateScheduledForErasureSince +

                                          Methods

                                          getBlob +getNote +update +

                                          Constructors

                                          Properties

                                          attachmentId: string
                                          contentLength: number

                                          optionally added to the entity

                                          +
                                          isProtected: boolean
                                          mime: string
                                          ownerId: string
                                          role: string
                                          title: string
                                          utcDateModified: string
                                          utcDateScheduledForErasureSince: string

                                          Methods

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Constructors
                                          Properties
                                          Methods
                                          diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.FAttribute.html b/docs/backend_api/classes/Frontend_Script_API._internal_.FAttribute.html new file mode 100644 index 000000000..aa4c6c554 --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.FAttribute.html @@ -0,0 +1,21 @@ +FAttribute | trilium
                                          trilium
                                            Preparing search index...

                                            Class FAttribute

                                            Attribute is an abstract concept which has two real uses - label (key - value pair) +and relation (representing named relationship between source and target note)

                                            +
                                            Index

                                            Constructors

                                            constructor +

                                            Properties

                                            attributeId +isInheritable +name +noteId +position +type +value +

                                            Accessors

                                            dto +isAutoLink +targetNoteId +toString +

                                            Methods

                                            getDefinition +getNote +getTargetNote +isDefinition +isDefinitionFor +update +

                                            Constructors

                                            Properties

                                            attributeId: string
                                            isInheritable: boolean
                                            name: string
                                            noteId: string
                                            position: number
                                            type: AttributeType
                                            value: string

                                            Accessors

                                            Methods

                                            Settings

                                            Member Visibility

                                            On This Page

                                            Constructors
                                            Properties
                                            Accessors
                                            Methods
                                            diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.FBranch.html b/docs/backend_api/classes/Frontend_Script_API._internal_.FBranch.html new file mode 100644 index 000000000..383f8c629 --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.FBranch.html @@ -0,0 +1,20 @@ +FBranch | trilium
                                            trilium
                                              Preparing search index...

                                              Class FBranch

                                              Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple +parents.

                                              +
                                              Index

                                              Constructors

                                              constructor +

                                              Properties

                                              branchId +fromSearchNote +isExpanded? +noteId +notePosition +parentNoteId +prefix? +

                                              Accessors

                                              pojo +toString +

                                              Methods

                                              getNote +getNoteFromCache +getParentNote +isTopLevel +update +

                                              Constructors

                                              Properties

                                              branchId: string

                                              primary key

                                              +
                                              fromSearchNote: boolean
                                              isExpanded?: boolean
                                              noteId: string
                                              notePosition: number
                                              parentNoteId: string
                                              prefix?: string

                                              Accessors

                                              Methods

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Constructors
                                              Properties
                                              Accessors
                                              Methods
                                              diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.FNote.html b/docs/backend_api/classes/Frontend_Script_API._internal_.FNote.html new file mode 100644 index 000000000..ed5438004 --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.FNote.html @@ -0,0 +1,181 @@ +FNote | trilium
                                              trilium
                                                Preparing search index...

                                                Class FNote

                                                Note is the main node and concept in Trilium.

                                                +
                                                Index

                                                Constructors

                                                constructor +

                                                Properties

                                                attachments +attributes +blobId +children +childToBranch +highlightedTokens? +isProtected +mime +noteId +parents +parentToBranch +searchResultsLoaded? +targetRelations +title +type +

                                                Accessors

                                                dto +isArchived +

                                                Methods

                                                __getInheritableAttributes +__validateTypeName +addChild +addParent +executeScript +getAllNotePaths +getAttachmentById +getAttachments +getAttachmentsByRole +getAttribute +getAttributes +getAttributeValue +getBestNotePath +getBestNotePathString +getBlob +getBranches +getBranchIds +getChildBranches +getChildNoteIds +getChildNotes +getColorClass +getContent +getCssClass +getFilteredChildBranches +getIcon +getJsonContent +getLabel +getLabels +getLabelValue +getMetadata +getNoteComplement +getNotesToInheritAttributesFrom +getOwnedAttribute +getOwnedAttributes +getOwnedAttributeValue +getOwnedLabel +getOwnedLabels +getOwnedLabelValue +getOwnedRelation +getOwnedRelations +getOwnedRelationValue +getParentBranches +getParentBranchIds +getParentNoteIds +getParentNotes +getPromotedDefinitionAttributes +getRelation +getRelations +getRelationTarget +getRelationTargets +getRelationValue +getScriptEnv +getSortedNotePathRecords +getTargetRelations +getTargetRelationSourceNotes +getWorkspaceIconClass +getWorkspaceTabBackgroundColor +hasAncestor +hasAttribute +hasChildren +hasLabel +hasOwnedAttribute +hasOwnedLabel +hasOwnedRelation +hasRelation +invalidateAttributeCache +isContentAvailable +isEligibleForConversionToAttachment +isFolder +isHiddenCompletely +isHtml +isInHiddenSubtree +isJavaScript +isJson +isLabelTruthy +isLaunchBarConfig +isOptions +isRoot +isShared +sortChildren +sortParents +toString +update +

                                                Constructors

                                                Properties

                                                attachments: null | FAttachment[]
                                                attributes: string[]
                                                blobId: string
                                                children: string[]
                                                childToBranch: Record<string, string>
                                                highlightedTokens?: string[]
                                                isProtected: boolean
                                                mime: string

                                                content-type, e.g. "application/json"

                                                +
                                                noteId: string
                                                parents: string[]
                                                parentToBranch: Record<string, string>
                                                searchResultsLoaded?: boolean
                                                targetRelations: string[]
                                                title: string
                                                type: NoteType

                                                Accessors

                                                Methods

                                                __getInheritableAttributes

                                                __validateTypeName

                                                • Parameters

                                                  • childNoteId: string
                                                  • branchId: string
                                                  • sort: boolean = true

                                                  Returns void

                                                • Parameters

                                                  • parentNoteId: string
                                                  • branchId: string
                                                  • sort: boolean = true

                                                  Returns void

                                                • Gives all possible note paths leading to this note. Paths containing search note are ignored (could form cycles)

                                                  +

                                                  Returns string[][]

                                                  array of notePaths (each represented by array of noteIds constituting the particular note path)

                                                  +

                                                • Parameters

                                                  • type: AttributeType

                                                    attribute type (label, relation, etc.)

                                                    +
                                                  • name: string

                                                    attribute name

                                                    +

                                                  Returns null | string

                                                  attribute value of the given type and name or null if no such attribute exists.

                                                  +

                                                • Returns the note path considered to be the "best"

                                                  +

                                                  Parameters

                                                  • OptionalhoistedNoteId: string = "root"

                                                  Returns string[]

                                                  array of noteIds constituting the particular note path

                                                  +

                                                • Returns the note path considered to be the "best"

                                                  +

                                                  Parameters

                                                  • OptionalhoistedNoteId: string = "root"

                                                  Returns string

                                                  serialized note path (e.g. 'root/a1h315/js725h')

                                                  +

                                                • Parameters

                                                  • name: string

                                                    label name

                                                    +

                                                  Returns null | string

                                                  label value if label exists, null otherwise

                                                  +

                                                • Parameters

                                                  • type: AttributeType

                                                    attribute type (label, relation, etc.)

                                                    +
                                                  • name: string

                                                    attribute name

                                                    +

                                                  Returns null | string

                                                  attribute value of the given type and name or null if no such attribute exists.

                                                  +

                                                • Parameters

                                                  • name: string

                                                    label name

                                                    +

                                                  Returns null | string

                                                  label value if label exists, null otherwise

                                                  +

                                                • Parameters

                                                  • name: string

                                                    relation name

                                                    +

                                                  Returns null | string

                                                  relation value if relation exists, null otherwise

                                                  +

                                                • Parameters

                                                  • name: string

                                                  Returns Promise<null | FNote>

                                                  target note of the relation or null (if target is empty or note was not found)

                                                  +

                                                • Parameters

                                                  • name: string

                                                    relation name

                                                    +

                                                  Returns null | string

                                                  relation value if relation exists, null otherwise

                                                  +

                                                • Returns null | "frontend" | "backend"

                                                  JS script environment - either "frontend" or "backend"

                                                  +

                                                • Parameters

                                                  • ancestorNoteId: string
                                                  • followTemplates: boolean = false
                                                  • visitedNoteIds: null | Set<string> = null

                                                  Returns boolean

                                                • Parameters

                                                  • name: string

                                                    relation name

                                                    +

                                                  Returns boolean

                                                  true if relation exists (excluding inherited)

                                                  +

                                                • Parameters

                                                  • name: string

                                                    relation name

                                                    +

                                                  Returns boolean

                                                  true if relation exists (including inherited)

                                                  +

                                                • Parameters

                                                  • name: string

                                                    label name

                                                    +

                                                  Returns boolean

                                                  true if label exists (including inherited) and does not have "false" value.

                                                  +

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Constructors
                                                Properties
                                                Accessors
                                                Methods
                                                __getInheritableAttributes__validateTypeNameaddChildaddParentexecuteScriptgetAllNotePathsgetAttachmentByIdgetAttachmentsgetAttachmentsByRolegetAttributegetAttributesgetAttributeValuegetBestNotePathgetBestNotePathStringgetBlobgetBranchesgetBranchIdsgetChildBranchesgetChildNoteIdsgetChildNotesgetColorClassgetContentgetCssClassgetFilteredChildBranchesgetIcongetJsonContentgetLabelgetLabelsgetLabelValuegetMetadatagetNoteComplementgetNotesToInheritAttributesFromgetOwnedAttributegetOwnedAttributesgetOwnedAttributeValuegetOwnedLabelgetOwnedLabelsgetOwnedLabelValuegetOwnedRelationgetOwnedRelationsgetOwnedRelationValuegetParentBranchesgetParentBranchIdsgetParentNoteIdsgetParentNotesgetPromotedDefinitionAttributesgetRelationgetRelationsgetRelationTargetgetRelationTargetsgetRelationValuegetScriptEnvgetSortedNotePathRecordsgetTargetRelationsgetTargetRelationSourceNotesgetWorkspaceIconClassgetWorkspaceTabBackgroundColorhasAncestorhasAttributehasChildrenhasLabelhasOwnedAttributehasOwnedLabelhasOwnedRelationhasRelationinvalidateAttributeCacheisContentAvailableisEligibleForConversionToAttachmentisFolderisHiddenCompletelyisHtmlisInHiddenSubtreeisJavaScriptisJsonisLabelTruthyisLaunchBarConfigisOptionsisRootisSharedsortChildrensortParentstoStringupdate
                                                diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.NoteContext.html b/docs/backend_api/classes/Frontend_Script_API._internal_.NoteContext.html new file mode 100644 index 000000000..a600dc67d --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.NoteContext.html @@ -0,0 +1,71 @@ +NoteContext | trilium
                                                trilium
                                                  Preparing search index...

                                                  Class NoteContext

                                                  Abstract class for all components in the Trilium's frontend.

                                                  +

                                                  Contains also event implementation with following properties:

                                                  +
                                                    +
                                                  • event / command distribution is synchronous which among others mean that events are well-ordered - event +which was sent out first will also be processed first by the component
                                                    • +
                                                  • execution of the event / command is asynchronous - each component executes the event on its own without regard for +other components.
                                                    • +
                                                  • although the execution is async, we are collecting all the promises, and therefore it is possible to wait until the +event / command is executed in all components - by simply awaiting the triggerEvent().
                                                    • +
                                                  +

                                                  Hierarchy (View Summary)

                                                  Implements

                                                  Index

                                                  Constructors

                                                  constructor +

                                                  Properties

                                                  _position +$widget +children +componentId +hoistedNoteId +initialized +mainNtxId +noteId? +notePath? +ntxId +parent? +parentNoteId? +viewScope? +

                                                  Accessors

                                                  note +notePathArray +position +sanitizedClassName +

                                                  Methods

                                                  callMethod +child +entitiesReloadedEvent +getCodeEditor +getContentElement +getMainContext +getNavigationTitle +getPojoState +getResolvedNotePath +getSubContexts +getTextEditor +getTypeWidget +handleEvent +handleEventInChildren +hasNoteList +isActive +isEmpty +isMainContext +isReadOnly +resetViewScope +saveToRecentNotes +setEmpty +setHoistedNoteId +setHoistedNoteIfNeeded +setNote +setParent +timeout +triggerCommand +triggerEvent +unhoist +generateNtxId +

                                                  Constructors

                                                  Properties

                                                  _position

                                                  _position: number
                                                  $widget: JQuery<HTMLElement>
                                                  children: default[]
                                                  componentId: string
                                                  hoistedNoteId: string
                                                  initialized: null | Promise<void>
                                                  mainNtxId: null | string
                                                  noteId?: null | string
                                                  notePath?: null | string
                                                  ntxId: null | string
                                                  parent?: TypedComponent<any>
                                                  parentNoteId?: null | string
                                                  viewScope?: ViewScope

                                                  Accessors

                                                  Methods

                                                  • Parameters

                                                    • fun: (arg: unknown) => Promise<unknown>
                                                    • data: unknown

                                                    Returns undefined | Promise<unknown>

                                                  • Returns a promise which will retrieve the JQuery element of the content of this note context.

                                                    +

                                                    Do note that retrieving the content element needs to be handled by the type widget, which is the one which +provides the content element by listening to the executeWithContentElement event. Not all note types support +this.

                                                    +

                                                    If no content could be determined null is returned instead.

                                                    +

                                                    Returns Promise<JQuery<HTMLElement>>

                                                  • Returns
                                                        | null
                                                        | {
                                                            active: boolean;
                                                            hoistedNoteId: string;
                                                            mainNtxId: null
                                                            | string;
                                                            notePath: undefined | null | string;
                                                            ntxId: null | string;
                                                            viewScope: undefined | ViewScope;
                                                        }

                                                  • A main context represents a tab and also the first split. Further splits are the children contexts of the main context. +Imagine you have a tab with 3 splits, each showing notes A, B, C (in this order). +In such a scenario, A context is the main context (also representing the tab as a whole), and B, C are the children +of context A.

                                                    +

                                                    Returns boolean

                                                    true if the context is main (= tab)

                                                    +

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Constructors
                                                  Properties
                                                  Accessors
                                                  Methods
                                                  diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.NoteContextAwareWidget.html b/docs/backend_api/classes/Frontend_Script_API._internal_.NoteContextAwareWidget.html new file mode 100644 index 000000000..fba427ba3 --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.NoteContextAwareWidget.html @@ -0,0 +1,84 @@ +NoteContextAwareWidget | trilium
                                                  trilium
                                                    Preparing search index...

                                                    Class NoteContextAwareWidget

                                                    This widget allows for changing and updating depending on the active note.

                                                    +

                                                    Hierarchy (View Summary)

                                                    Index

                                                    Constructors

                                                    constructor +

                                                    Properties

                                                    _noteId +_position +$widget +attrs +children +componentId +initialized +noteContext? +parent? +

                                                    Accessors

                                                    hoistedNoteId +note +noteId +notePath +ntxId +position +sanitizedClassName +

                                                    Methods

                                                    activeContextChanged +activeContextChangedEvent +callMethod +canBeShown +child +class +cleanup +collapsible +contentSized +css +cssBlock +doRender +filling +frocaReloadedEvent +getClosestNtxId +getPosition +handleEvent +handleEventInChildren +id +isActiveNoteContext +isEnabled +isHiddenExt +isHiddenInt +isNote +isNoteContext +isVisible +logRenderingError +noteSwitched +noteSwitchedAndActivatedEvent +noteSwitchedEvent +noteTypeMimeChangedEvent +optChild +optCss +refresh +refreshWithNote +remove +render +setNoteContextEvent +setParent +toggleExt +toggleInt +triggerCommand +triggerEvent +

                                                    Constructors

                                                    Properties

                                                    _noteId

                                                    _noteId: string

                                                    _position

                                                    _position: number
                                                    $widget: JQuery<HTMLElement>
                                                    attrs: Record<string, string>
                                                    children: default[]
                                                    componentId: string
                                                    initialized: null | Promise<void>
                                                    noteContext?: NoteContext
                                                    parent?: TypedComponent<any>

                                                    Accessors

                                                    Methods

                                                    • Parameters

                                                      • fun: (arg: unknown) => Promise<unknown>
                                                      • data: unknown

                                                      Returns undefined | Promise<unknown>

                                                    • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                                      +

                                                      +If the widget is not enabled, it will not receive `refreshWithNote` updates.

                                                      Returns undefined | null | boolean

                                                      true when an active note exists

                                                      +

                                                    • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                                      +

                                                      Parameters

                                                      • condition: boolean

                                                        true in order to apply the CSS, false to ignore it.

                                                        +
                                                      • name: string

                                                        the name of the CSS attribute to set (e.g. padding-left).

                                                        +
                                                      • value: string

                                                        the value of the CSS attribute to set (e.g. 12px).

                                                        +

                                                      Returns NoteContextAwareWidget

                                                      self for chaining.

                                                      +

                                                    Settings

                                                    Member Visibility

                                                    On This Page

                                                    Constructors
                                                    Properties
                                                    Accessors
                                                    Methods
                                                    diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.RightPanelWidget.html b/docs/backend_api/classes/Frontend_Script_API._internal_.RightPanelWidget.html new file mode 100644 index 000000000..b63e746cf --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.RightPanelWidget.html @@ -0,0 +1,92 @@ +RightPanelWidget | trilium
                                                    trilium
                                                      Preparing search index...

                                                      Class RightPanelWidget

                                                      This widget manages rendering panels in the right-hand pane.

                                                      +

                                                      Hierarchy (View Summary)

                                                      Index

                                                      Constructors

                                                      constructor +

                                                      Properties

                                                      _noteId +_position +$body +$widget +attrs +children +componentId +initialized +noteContext? +parent? +

                                                      Accessors

                                                      help +hoistedNoteId +note +noteId +notePath +ntxId +position +sanitizedClassName +widgetButtons +widgetTitle +

                                                      Methods

                                                      activeContextChanged +activeContextChangedEvent +callMethod +canBeShown +child +class +cleanup +collapsible +contentSized +css +cssBlock +doRender +doRenderBody +filling +frocaReloadedEvent +getClosestNtxId +getPosition +handleEvent +handleEventInChildren +id +isActiveNoteContext +isEnabled +isHiddenExt +isHiddenInt +isNote +isNoteContext +isVisible +logRenderingError +noteSwitched +noteSwitchedAndActivatedEvent +noteSwitchedEvent +noteTypeMimeChangedEvent +optChild +optCss +refresh +refreshWithNote +remove +render +setNoteContextEvent +setParent +toggleExt +toggleInt +triggerCommand +triggerEvent +

                                                      Constructors

                                                      Properties

                                                      _noteId

                                                      _noteId: string

                                                      _position

                                                      _position: number

                                                      $body

                                                      $body: JQuery<HTMLElement>
                                                      $widget: JQuery<HTMLElement>
                                                      attrs: Record<string, string>
                                                      children: default[]
                                                      componentId: string
                                                      initialized: null | Promise<void>
                                                      noteContext?: NoteContext
                                                      parent?: TypedComponent<any>

                                                      Accessors

                                                      Methods

                                                      • Method used for rendering the body of the widget (via existing this.$body)

                                                        +

                                                        Your class should override this method.

                                                        +

                                                        Returns Promise<void>

                                                        if widget needs async operation to initialize, it can return a Promise

                                                        +

                                                      • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                                        +

                                                        +If the widget is not enabled, it will not receive `refreshWithNote` updates.

                                                        Returns undefined | null | boolean

                                                        true when an active note exists

                                                        +

                                                      • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                                        +

                                                        Parameters

                                                        • condition: boolean

                                                          true in order to apply the CSS, false to ignore it.

                                                          +
                                                        • name: string

                                                          the name of the CSS attribute to set (e.g. padding-left).

                                                          +
                                                        • value: string

                                                          the value of the CSS attribute to set (e.g. 12px).

                                                          +

                                                        Returns RightPanelWidget

                                                        self for chaining.

                                                        +

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Constructors
                                                      Properties
                                                      Accessors
                                                      Methods
                                                      diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.TypedComponent.html b/docs/backend_api/classes/Frontend_Script_API._internal_.TypedComponent.html new file mode 100644 index 000000000..f75df9005 --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.TypedComponent.html @@ -0,0 +1,27 @@ +TypedComponent | trilium
                                                      trilium
                                                        Preparing search index...

                                                        Class TypedComponent<ChildT>

                                                        Abstract class for all components in the Trilium's frontend.

                                                        +

                                                        Contains also event implementation with following properties:

                                                        +
                                                          +
                                                        • event / command distribution is synchronous which among others mean that events are well-ordered - event +which was sent out first will also be processed first by the component
                                                          • +
                                                        • execution of the event / command is asynchronous - each component executes the event on its own without regard for +other components.
                                                          • +
                                                        • although the execution is async, we are collecting all the promises, and therefore it is possible to wait until the +event / command is executed in all components - by simply awaiting the triggerEvent().
                                                          • +
                                                        +

                                                        Type Parameters

                                                        Hierarchy (View Summary)

                                                        Index

                                                        Constructors

                                                        constructor +

                                                        Properties

                                                        _position +$widget +children +componentId +initialized +parent? +

                                                        Accessors

                                                        position +sanitizedClassName +

                                                        Methods

                                                        callMethod +child +handleEvent +handleEventInChildren +setParent +triggerCommand +triggerEvent +

                                                        Constructors

                                                        Properties

                                                        _position

                                                        _position: number
                                                        $widget: JQuery<HTMLElement>
                                                        children: ChildT[]
                                                        componentId: string
                                                        initialized: null | Promise<void>
                                                        parent?: TypedComponent<any>

                                                        Accessors

                                                        Methods

                                                        • Parameters

                                                          • fun: (arg: unknown) => Promise<unknown>
                                                          • data: unknown

                                                          Returns undefined | Promise<unknown>

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Constructors
                                                        Properties
                                                        Accessors
                                                        Methods
                                                        diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-1.html b/docs/backend_api/classes/Frontend_Script_API._internal_.default-1.html new file mode 100644 index 000000000..d39722a1d --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.default-1.html @@ -0,0 +1,104 @@ +default | trilium
                                                        trilium
                                                          Preparing search index...

                                                          Class default

                                                          This widget allows for changing and updating depending on the active note.

                                                          +

                                                          Hierarchy (View Summary)

                                                          Index

                                                          Constructors

                                                          constructor +

                                                          Properties

                                                          _noteId +_position +$widget +attrs +children +componentId +initialized +noteContext? +parent? +

                                                          Accessors

                                                          hoistedNoteId +note +noteId +notePath +ntxId +position +sanitizedClassName +

                                                          Methods

                                                          activeContextChanged +activeContextChangedEvent +beforeNoteContextRemoveEvent +beforeNoteSwitchEvent +beforeUnloadEvent +callMethod +canBeShown +checkFullHeight +child +class +cleanup +collapsible +contentSized +css +cssBlock +cutIntoNoteCommand +doRender +entitiesReloadedEvent +executeInActiveNoteDetailWidgetEvent +executeWithTypeWidgetEvent +exportAsPdfEvent +filling +focusOnDetailEvent +frocaReloadedEvent +getClosestNtxId +getPosition +getTypeWidget +getWidgetType +handleEvent +handleEventInChildren +hoistedNoteChangedEvent +id +isActiveNoteContext +isEnabled +isHiddenExt +isHiddenInt +isNote +isNoteContext +isVisible +logRenderingError +noteSwitched +noteSwitchedAndActivatedEvent +noteSwitchedEvent +noteTypeMimeChangedEvent +optChild +optCss +printActiveNoteEvent +readOnlyTemporarilyDisabledEvent +refresh +refreshWithNote +remove +render +renderActiveNoteEvent +runActiveNoteCommand +saveNoteDetailNowCommand +scrollToEndEvent +setNoteContextEvent +setParent +toggleExt +toggleInt +triggerCommand +triggerEvent +

                                                          Constructors

                                                          Properties

                                                          _noteId

                                                          _noteId: string

                                                          _position

                                                          _position: number
                                                          $widget: JQuery<HTMLElement>
                                                          attrs: Record<string, string>
                                                          children: default[]
                                                          componentId: string
                                                          initialized: null | Promise<void>
                                                          noteContext?: NoteContext
                                                          parent?: TypedComponent<any>

                                                          Accessors

                                                          Methods

                                                          • Parameters

                                                            • __namedParameters: { ntxIds: string[] }

                                                            Returns Promise<void>

                                                          • Parameters

                                                            • __namedParameters: { noteId: string; ntxId: null | string }

                                                            Returns void

                                                          • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                                            +

                                                            +If the widget is not enabled, it will not receive `refreshWithNote` updates.

                                                            Returns boolean

                                                            true when an active note exists

                                                            +

                                                          • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                                            +

                                                            Parameters

                                                            • condition: boolean

                                                              true in order to apply the CSS, false to ignore it.

                                                              +
                                                            • name: string

                                                              the name of the CSS attribute to set (e.g. padding-left).

                                                              +
                                                            • value: string

                                                              the value of the CSS attribute to set (e.g. 12px).

                                                              +

                                                            Returns default

                                                            self for chaining.

                                                            +

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          Constructors
                                                          Properties
                                                          Accessors
                                                          Methods
                                                          activeContextChangedactiveContextChangedEventbeforeNoteContextRemoveEventbeforeNoteSwitchEventbeforeUnloadEventcallMethodcanBeShowncheckFullHeightchildclasscleanupcollapsiblecontentSizedcsscssBlockcutIntoNoteCommanddoRenderentitiesReloadedEventexecuteInActiveNoteDetailWidgetEventexecuteWithTypeWidgetEventexportAsPdfEventfillingfocusOnDetailEventfrocaReloadedEventgetClosestNtxIdgetPositiongetTypeWidgetgetWidgetTypehandleEventhandleEventInChildrenhoistedNoteChangedEventidisActiveNoteContextisEnabledisHiddenExtisHiddenIntisNoteisNoteContextisVisiblelogRenderingErrornoteSwitchednoteSwitchedAndActivatedEventnoteSwitchedEventnoteTypeMimeChangedEventoptChildoptCssprintActiveNoteEventreadOnlyTemporarilyDisabledEventrefreshrefreshWithNoteremoverenderrenderActiveNoteEventrunActiveNoteCommandsaveNoteDetailNowCommandscrollToEndEventsetNoteContextEventsetParenttoggleExttoggleInttriggerCommandtriggerEvent
                                                          diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-2.html b/docs/backend_api/classes/Frontend_Script_API._internal_.default-2.html new file mode 100644 index 000000000..3b126761b --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.default-2.html @@ -0,0 +1,27 @@ +default | trilium
                                                          trilium
                                                            Preparing search index...

                                                            Class default

                                                            Abstract class for all components in the Trilium's frontend.

                                                            +

                                                            Contains also event implementation with following properties:

                                                            +
                                                              +
                                                            • event / command distribution is synchronous which among others mean that events are well-ordered - event +which was sent out first will also be processed first by the component
                                                              • +
                                                            • execution of the event / command is asynchronous - each component executes the event on its own without regard for +other components.
                                                              • +
                                                            • although the execution is async, we are collecting all the promises, and therefore it is possible to wait until the +event / command is executed in all components - by simply awaiting the triggerEvent().
                                                              • +
                                                            +

                                                            Hierarchy (View Summary)

                                                            Index

                                                            Constructors

                                                            constructor +

                                                            Properties

                                                            _position +$widget +children +componentId +initialized +parent? +

                                                            Accessors

                                                            position +sanitizedClassName +

                                                            Methods

                                                            callMethod +child +handleEvent +handleEventInChildren +setParent +triggerCommand +triggerEvent +

                                                            Constructors

                                                            Properties

                                                            _position

                                                            _position: number
                                                            $widget: JQuery<HTMLElement>
                                                            children: default[]
                                                            componentId: string
                                                            initialized: null | Promise<void>
                                                            parent?: TypedComponent<any>

                                                            Accessors

                                                            Methods

                                                            Settings

                                                            Member Visibility

                                                            On This Page

                                                            Constructors
                                                            Properties
                                                            Accessors
                                                            Methods
                                                            diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-3.html b/docs/backend_api/classes/Frontend_Script_API._internal_.default-3.html new file mode 100644 index 000000000..3f3b16bf9 --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.default-3.html @@ -0,0 +1,10 @@ +default | trilium
                                                            trilium
                                                              Preparing search index...

                                                              Class default

                                                              Index

                                                              Constructors

                                                              constructor +

                                                              Methods

                                                              allowUpdateWithoutChange +isAllSavedAndTriggerUpdate +resetUpdateTimer +scheduleUpdate +triggerUpdate +updateNowIfNecessary +

                                                              Constructors

                                                              Methods

                                                              • Normally () would actually trigger the update only once per updateInterval. If the method is called 200 times within 20s, it will execute only 20 times. +Sometimes, if the updates are continuous this would cause a performance impact. Resetting the time ensures that the calls to triggerUpdate have stopped before actually triggering an update.

                                                                +

                                                                Returns void

                                                              Settings

                                                              Member Visibility

                                                              On This Page

                                                              Constructors
                                                              Methods
                                                              diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-4.html b/docs/backend_api/classes/Frontend_Script_API._internal_.default-4.html new file mode 100644 index 000000000..9067f9e43 --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.default-4.html @@ -0,0 +1,11 @@ +default | trilium
                                                              trilium
                                                                Preparing search index...

                                                                Class default

                                                                Index

                                                                Constructors

                                                                constructor +

                                                                Properties

                                                                blobId +content +contentLength +dateModified +utcDateModified +

                                                                Methods

                                                                getJsonContent +getJsonContentSafely +

                                                                Constructors

                                                                Properties

                                                                blobId: string

                                                                content

                                                                content: string

                                                                can either contain the whole content (in e.g. string notes), only part (large text notes) or nothing at all (binary notes, images)

                                                                +
                                                                contentLength: number
                                                                dateModified: string
                                                                utcDateModified: string

                                                                Methods

                                                                Settings

                                                                Member Visibility

                                                                On This Page

                                                                Constructors
                                                                Properties
                                                                Methods
                                                                diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-5.html b/docs/backend_api/classes/Frontend_Script_API._internal_.default-5.html new file mode 100644 index 000000000..a3d90a461 --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.default-5.html @@ -0,0 +1,93 @@ +default | trilium
                                                                trilium
                                                                  Preparing search index...

                                                                  Class default<SettingsT>

                                                                  This widget allows for changing and updating depending on the active note.

                                                                  +

                                                                  Type Parameters

                                                                  • SettingsT extends AbstractButtonWidgetSettings

                                                                  Hierarchy (View Summary)

                                                                  Index

                                                                  Constructors

                                                                  constructor +

                                                                  Properties

                                                                  _noteId +_position +$widget +attrs +children +componentId +initialized +noteContext? +parent? +settings +tooltip +

                                                                  Accessors

                                                                  hoistedNoteId +note +noteId +notePath +ntxId +position +sanitizedClassName +

                                                                  Methods

                                                                  activeContextChanged +activeContextChangedEvent +callMethod +canBeShown +child +class +cleanup +collapsible +contentSized +css +cssBlock +doRender +filling +frocaReloadedEvent +getClosestNtxId +getPosition +getTitle +handleEvent +handleEventInChildren +icon +id +initialRenderCompleteEvent +isActiveNoteContext +isEnabled +isHiddenExt +isHiddenInt +isNote +isNoteContext +isVisible +logRenderingError +noteSwitched +noteSwitchedAndActivatedEvent +noteSwitchedEvent +noteTypeMimeChangedEvent +onContextMenu +optChild +optCss +refresh +refreshIcon +refreshWithNote +remove +render +setNoteContextEvent +setParent +title +titlePlacement +toggleExt +toggleInt +triggerCommand +triggerEvent +

                                                                  Constructors

                                                                  Properties

                                                                  _noteId

                                                                  _noteId: string

                                                                  _position

                                                                  _position: number
                                                                  $widget: JQuery<HTMLElement>
                                                                  attrs: Record<string, string>
                                                                  children: default[]
                                                                  componentId: string
                                                                  initialized: null | Promise<void>
                                                                  noteContext?: NoteContext
                                                                  parent?: TypedComponent<any>
                                                                  settings: SettingsT
                                                                  tooltip: Tooltip

                                                                  Accessors

                                                                  Methods

                                                                  • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                                                    +

                                                                    +If the widget is not enabled, it will not receive `refreshWithNote` updates.

                                                                    Returns undefined | null | boolean

                                                                    true when an active note exists

                                                                    +

                                                                  • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                                                    +

                                                                    Parameters

                                                                    • condition: boolean

                                                                      true in order to apply the CSS, false to ignore it.

                                                                      +
                                                                    • name: string

                                                                      the name of the CSS attribute to set (e.g. padding-left).

                                                                      +
                                                                    • value: string

                                                                      the value of the CSS attribute to set (e.g. 12px).

                                                                      +

                                                                    Returns default<SettingsT>

                                                                    self for chaining.

                                                                    +

                                                                  Settings

                                                                  Member Visibility

                                                                  On This Page

                                                                  Constructors
                                                                  Properties
                                                                  Accessors
                                                                  Methods
                                                                  diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-6.html b/docs/backend_api/classes/Frontend_Script_API._internal_.default-6.html new file mode 100644 index 000000000..16e447f30 --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.default-6.html @@ -0,0 +1,100 @@ +default | trilium
                                                                  trilium
                                                                    Preparing search index...

                                                                    Class defaultAbstract

                                                                    The base class for all the note types.

                                                                    +

                                                                    Hierarchy (View Summary)

                                                                    Index

                                                                    Constructors

                                                                    constructor +

                                                                    Properties

                                                                    _noteId +_position +$widget +attrs +children +componentId +initialized +noteContext? +parent? +spacedUpdate +

                                                                    Accessors

                                                                    hoistedNoteId +note +noteId +notePath +ntxId +position +sanitizedClassName +

                                                                    Methods

                                                                    activeContextChanged +activeContextChangedEvent +callMethod +canBeShown +child +class +cleanup +collapsible +contentSized +css +cssBlock +dataSaved +doRefresh +doRender +filling +focus +frocaReloadedEvent +getClosestNtxId +getData +getPosition +handleEvent +handleEventInChildren +id +isActive +isActiveNoteContext +isEnabled +isHiddenExt +isHiddenInt +isNote +isNoteContext +isVisible +logRenderingError +noteSwitched +noteSwitchedAndActivatedEvent +noteSwitchedEvent +noteTypeMimeChangedEvent +optChild +optCss +readOnlyTemporarilyDisabledEvent +refresh +refreshWithNote +remove +render +scrollToEnd +setNoteContextEvent +setParent +toggleExt +toggleInt +triggerCommand +triggerEvent +getType +

                                                                    Constructors

                                                                    Properties

                                                                    _noteId

                                                                    _noteId: string

                                                                    _position

                                                                    _position: number
                                                                    $widget: JQuery<HTMLElement>
                                                                    attrs: Record<string, string>
                                                                    children: default[]
                                                                    componentId: string
                                                                    initialized: null | Promise<void>
                                                                    noteContext?: NoteContext
                                                                    parent?: TypedComponent<any>
                                                                    spacedUpdate: default

                                                                    Accessors

                                                                    Methods

                                                                    • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                                                      +

                                                                      +If the widget is not enabled, it will not receive `refreshWithNote` updates.

                                                                      Returns undefined | null | boolean

                                                                      true when an active note exists

                                                                      +

                                                                    • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                                                      +

                                                                      Parameters

                                                                      • condition: boolean

                                                                        true in order to apply the CSS, false to ignore it.

                                                                        +
                                                                      • name: string

                                                                        the name of the CSS attribute to set (e.g. padding-left).

                                                                        +
                                                                      • value: string

                                                                        the value of the CSS attribute to set (e.g. 12px).

                                                                        +

                                                                      Returns default

                                                                      self for chaining.

                                                                      +

                                                                    Settings

                                                                    Member Visibility

                                                                    On This Page

                                                                    Constructors
                                                                    Properties
                                                                    Accessors
                                                                    Methods
                                                                    diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-7.html b/docs/backend_api/classes/Frontend_Script_API._internal_.default-7.html new file mode 100644 index 000000000..62ada970c --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.default-7.html @@ -0,0 +1,131 @@ +default | trilium
                                                                    trilium
                                                                      Preparing search index...

                                                                      Class default

                                                                      The editor can operate into two distinct modes:

                                                                      + +

                                                                      Hierarchy

                                                                      • default
                                                                        • default
                                                                      Index

                                                                      Constructors

                                                                      constructor +

                                                                      Properties

                                                                      _noteId +_position +$widget +attrs +children +componentId +initialized +noteContext? +parent? +spacedUpdate +

                                                                      Accessors

                                                                      hoistedNoteId +note +noteId +notePath +ntxId +position +sanitizedClassName +

                                                                      Methods

                                                                      activeContextChanged +activeContextChangedEvent +addImage +addIncludeNote +addIncludeNoteToTextCommand +addLink +addLinkToEditor +addLinkToTextCommand +addTextToActiveEditorEvent +addTextToEditor +callMethod +canBeShown +child +class +cleanup +collapsible +contentSized +createEditor +createNoteForReferenceLink +css +cssBlock +dataSaved +doRefresh +doRender +entitiesReloadedEvent +executeWithTextEditorEvent +filling +focus +followLinkUnderCursorCommand +frocaReloadedEvent +getClosestNtxId +getData +getEditor +getPosition +getSelectedText +handleEvent +handleEventInChildren +hasSelection +id +initEditor +insertDateTimeToTextCommand +isActive +isActiveNoteContext +isEnabled +isHiddenExt +isHiddenInt +isNote +isNoteContext +isVisible +loadIncludedNote +loadReferenceLinkTitle +logRenderingError +noteSwitched +noteSwitchedAndActivatedEvent +noteSwitchedEvent +noteTypeMimeChangedEvent +onLanguageChanged +openImageInCurrentTab +openImageInNewTab +optChild +optCss +parseFromImage +readOnlyTemporarilyDisabledEvent +refresh +refreshCodeBlockOptions +refreshIncludedNote +refreshIncludedNoteEvent +refreshWithNote +reinitialize +remove +render +scrollToEnd +setNoteContextEvent +setParent +setupImageOpening +show +toggleExt +toggleInt +triggerCommand +triggerEvent +getType +

                                                                      Constructors

                                                                      Properties

                                                                      _noteId

                                                                      _noteId: string

                                                                      _position

                                                                      _position: number
                                                                      $widget: JQuery<HTMLElement>
                                                                      attrs: Record<string, string>
                                                                      children: default[]
                                                                      componentId: string
                                                                      initialized: null | Promise<void>
                                                                      noteContext?: NoteContext
                                                                      parent?: TypedComponent<any>
                                                                      spacedUpdate: default

                                                                      Accessors

                                                                      Methods

                                                                      • Parameters

                                                                        • notePath: string
                                                                        • linkTitle: null | string
                                                                        • externalLink: boolean = false

                                                                        Returns Promise<void>

                                                                      • Parameters

                                                                        • fun: (arg: unknown) => Promise<unknown>
                                                                        • data: unknown

                                                                        Returns undefined | Promise<unknown>

                                                                      • Sets the CSS attribute of the given name to the given value.

                                                                        +

                                                                        Parameters

                                                                        • name: string

                                                                          the name of the CSS attribute to set (e.g. padding-left).

                                                                          +
                                                                        • value: string

                                                                          the value of the CSS attribute to set (e.g. 12px).

                                                                          +

                                                                        Returns default

                                                                        self for chaining.

                                                                        +

                                                                      • By default:

                                                                        +
                                                                          +
                                                                        • activeContextChanged is intercepted and converted to a setNoteContext event to avoid refresh().
                                                                          • +
                                                                        • entitiesReloaded and refreshData are passed as-is.
                                                                          • +
                                                                        • any other event is not passed to the children.
                                                                          • +
                                                                        +

                                                                        Type Parameters

                                                                        Parameters

                                                                        Returns null | Promise<unknown>

                                                                      • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                                                        +

                                                                        +If the widget is not enabled, it will not receive `refreshWithNote` updates.

                                                                        Returns undefined | null | boolean

                                                                        true when an active note exists

                                                                        +

                                                                      • Parameters

                                                                        • ntxId: undefined | null | string | string[]

                                                                        Returns undefined | null | boolean | ""

                                                                      • Conditionally adds the given components as children to this component.

                                                                        +

                                                                        Parameters

                                                                        • condition: boolean

                                                                          whether to add the components.

                                                                          +
                                                                        • ...components: default[]

                                                                          the components to be added as children to this component provided the condition is truthy.

                                                                          +

                                                                        Returns default

                                                                        self for chaining.

                                                                        +

                                                                      • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                                                        +

                                                                        Parameters

                                                                        • condition: boolean

                                                                          true in order to apply the CSS, false to ignore it.

                                                                          +
                                                                        • name: string

                                                                          the name of the CSS attribute to set (e.g. padding-left).

                                                                          +
                                                                        • value: string

                                                                          the value of the CSS attribute to set (e.g. 12px).

                                                                          +

                                                                        Returns default

                                                                        self for chaining.

                                                                        +

                                                                      • Parameters

                                                                        • $img: JQuery<HTMLElement>

                                                                        Returns Promise<
                                                                            | null
                                                                            | {
                                                                                noteId: any;
                                                                                viewScope: { attachmentId?: undefined; viewMode?: undefined };
                                                                            }
                                                                            | {
                                                                                noteId: undefined
                                                                                | string;
                                                                                viewScope: { attachmentId: any; viewMode: string };
                                                                            },
                                                                        >

                                                                      • Parameters

                                                                        • show: undefined | null | boolean | ""

                                                                        Returns void

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Constructors
                                                                      Properties
                                                                      Accessors
                                                                      Methods
                                                                      activeContextChangedactiveContextChangedEventaddImageaddIncludeNoteaddIncludeNoteToTextCommandaddLinkaddLinkToEditoraddLinkToTextCommandaddTextToActiveEditorEventaddTextToEditorcallMethodcanBeShownchildclasscleanupcollapsiblecontentSizedcreateEditorcreateNoteForReferenceLinkcsscssBlockdataSaveddoRefreshdoRenderentitiesReloadedEventexecuteWithTextEditorEventfillingfocusfollowLinkUnderCursorCommandfrocaReloadedEventgetClosestNtxIdgetDatagetEditorgetPositiongetSelectedTexthandleEventhandleEventInChildrenhasSelectionidinitEditorinsertDateTimeToTextCommandisActiveisActiveNoteContextisEnabledisHiddenExtisHiddenIntisNoteisNoteContextisVisibleloadIncludedNoteloadReferenceLinkTitlelogRenderingErrornoteSwitchednoteSwitchedAndActivatedEventnoteSwitchedEventnoteTypeMimeChangedEventonLanguageChangedopenImageInCurrentTabopenImageInNewTaboptChildoptCssparseFromImagereadOnlyTemporarilyDisabledEventrefreshrefreshCodeBlockOptionsrefreshIncludedNoterefreshIncludedNoteEventrefreshWithNotereinitializeremoverenderscrollToEndsetNoteContextEventsetParentsetupImageOpeningshowtoggleExttoggleInttriggerCommandtriggerEventgetType
                                                                      diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default-8.html b/docs/backend_api/classes/Frontend_Script_API._internal_.default-8.html new file mode 100644 index 000000000..66874db79 --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.default-8.html @@ -0,0 +1,26 @@ +default | trilium
                                                                      trilium
                                                                        Preparing search index...

                                                                        Class default

                                                                        Index

                                                                        Constructors

                                                                        constructor +

                                                                        Methods

                                                                        addAttachmentRow +addAttribute +addBranch +addNote +addNoteContent +addNoteReordering +addOption +addRevision +getAttachmentRows +getAttributeRows +getBranchRows +getEntityRow +getNoteIds +getNoteReorderings +getOptionNames +hasAttributeRelatedChanges +hasRevisionForNote +isEmpty +isEmptyForTree +isNoteContentReloaded +isNoteReloaded +isOptionReloaded +

                                                                        Constructors

                                                                        Methods

                                                                        • Parameters

                                                                          • revisionId: string
                                                                          • OptionalnoteId: string
                                                                          • OptionalcomponentId: null | string

                                                                          Returns void

                                                                        • Type Parameters

                                                                          • T extends keyof EntityRowMappings

                                                                          Parameters

                                                                          • entityName: T
                                                                          • entityId: string

                                                                          Returns EntityRowMappings[T]

                                                                        • Returns boolean

                                                                          true if there are changes which could affect the attributes (including inherited ones) +notably changes in note itself should not have any effect on attributes

                                                                          +

                                                                        • Parameters

                                                                          • noteId: string
                                                                          • OptionalcomponentId: string

                                                                          Returns undefined | false | ContentNoteIdToComponentIdRow

                                                                        • Parameters

                                                                          • noteId: undefined | null | string
                                                                          • componentId: null | string = null

                                                                          Returns boolean

                                                                        Settings

                                                                        Member Visibility

                                                                        On This Page

                                                                        Constructors
                                                                        Methods
                                                                        diff --git a/docs/backend_api/classes/Frontend_Script_API._internal_.default.html b/docs/backend_api/classes/Frontend_Script_API._internal_.default.html new file mode 100644 index 000000000..cc0522a80 --- /dev/null +++ b/docs/backend_api/classes/Frontend_Script_API._internal_.default.html @@ -0,0 +1,64 @@ +default | trilium
                                                                        trilium
                                                                          Preparing search index...

                                                                          Class default

                                                                          This is the base widget for all other widgets.

                                                                          +

                                                                          For information on using widgets, see the tutorial {@tutorial widget_basics}.

                                                                          +

                                                                          Hierarchy (View Summary)

                                                                          Index

                                                                          Constructors

                                                                          constructor +

                                                                          Properties

                                                                          _noteId +_position +$widget +attrs +children +componentId +initialized +parent? +

                                                                          Accessors

                                                                          position +sanitizedClassName +

                                                                          Methods

                                                                          callMethod +canBeShown +child +class +cleanup +collapsible +contentSized +css +cssBlock +doRender +filling +getClosestNtxId +getPosition +handleEvent +handleEventInChildren +id +isEnabled +isHiddenExt +isHiddenInt +isVisible +logRenderingError +optChild +optCss +remove +render +setParent +toggleExt +toggleInt +triggerCommand +triggerEvent +

                                                                          Constructors

                                                                          Properties

                                                                          _noteId

                                                                          _noteId: string

                                                                          _position

                                                                          _position: number
                                                                          $widget: JQuery<HTMLElement>
                                                                          attrs: Record<string, string>
                                                                          children: default[]
                                                                          componentId: string
                                                                          initialized: null | Promise<void>
                                                                          parent?: TypedComponent<any>

                                                                          Accessors

                                                                          Methods

                                                                          • Parameters

                                                                            • fun: (arg: unknown) => Promise<unknown>
                                                                            • data: unknown

                                                                            Returns undefined | Promise<unknown>

                                                                          • Sets the CSS attribute of the given name to the given value.

                                                                            +

                                                                            Parameters

                                                                            • name: string

                                                                              the name of the CSS attribute to set (e.g. padding-left).

                                                                              +
                                                                            • value: string

                                                                              the value of the CSS attribute to set (e.g. 12px).

                                                                              +

                                                                            Returns default

                                                                            self for chaining.

                                                                            +

                                                                          • Method used for rendering the widget.

                                                                            +

                                                                            Your class should override this method. +The method is expected to create a this.$widget containing jQuery object

                                                                            +

                                                                            Returns void

                                                                          • Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.

                                                                            +

                                                                            Returns undefined | null | boolean

                                                                            whether the widget is enabled.

                                                                            +

                                                                          • Conditionally adds the given components as children to this component.

                                                                            +

                                                                            Parameters

                                                                            • condition: boolean

                                                                              whether to add the components.

                                                                              +
                                                                            • ...components: default[]

                                                                              the components to be added as children to this component provided the condition is truthy.

                                                                              +

                                                                            Returns default

                                                                            self for chaining.

                                                                            +

                                                                          • Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.

                                                                            +

                                                                            Parameters

                                                                            • condition: boolean

                                                                              true in order to apply the CSS, false to ignore it.

                                                                              +
                                                                            • name: string

                                                                              the name of the CSS attribute to set (e.g. padding-left).

                                                                              +
                                                                            • value: string

                                                                              the value of the CSS attribute to set (e.g. 12px).

                                                                              +

                                                                            Returns default

                                                                            self for chaining.

                                                                            +

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Constructors
                                                                          Properties
                                                                          Accessors
                                                                          Methods
                                                                          diff --git a/docs/backend_api/enums/Frontend_Script_API._internal_.FancytreeClickFolderMode.html b/docs/backend_api/enums/Frontend_Script_API._internal_.FancytreeClickFolderMode.html new file mode 100644 index 000000000..a57ca2482 --- /dev/null +++ b/docs/backend_api/enums/Frontend_Script_API._internal_.FancytreeClickFolderMode.html @@ -0,0 +1,5 @@ +FancytreeClickFolderMode | trilium
                                                                          trilium
                                                                            Preparing search index...

                                                                            Enumeration FancytreeClickFolderMode

                                                                            Index

                                                                            Enumeration Members

                                                                            activate +activate_and_expand +activate_dblclick_expands +expand +

                                                                            Enumeration Members

                                                                            activate: 1
                                                                            activate_and_expand: 3
                                                                            activate_dblclick_expands: 4
                                                                            expand: 2

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Enumeration Members
                                                                            diff --git a/docs/backend_api/enums/Frontend_Script_API._internal_.FancytreeSelectMode.html b/docs/backend_api/enums/Frontend_Script_API._internal_.FancytreeSelectMode.html new file mode 100644 index 000000000..fbbd56641 --- /dev/null +++ b/docs/backend_api/enums/Frontend_Script_API._internal_.FancytreeSelectMode.html @@ -0,0 +1,4 @@ +FancytreeSelectMode | trilium
                                                                            trilium
                                                                              Preparing search index...

                                                                              Enumeration FancytreeSelectMode

                                                                              Index

                                                                              Enumeration Members

                                                                              multi +mutlti_hier +single +

                                                                              Enumeration Members

                                                                              multi: 2
                                                                              mutlti_hier: 3
                                                                              single: 1

                                                                              Settings

                                                                              Member Visibility

                                                                              On This Page

                                                                              Enumeration Members
                                                                              diff --git a/docs/backend_api/hierarchy.html b/docs/backend_api/hierarchy.html index ee95a982a..0a4de32a8 100644 --- a/docs/backend_api/hierarchy.html +++ b/docs/backend_api/hierarchy.html @@ -1 +1 @@ -trilium
                                                                              trilium
                                                                                Preparing search index...

                                                                                trilium

                                                                                Hierarchy Summary

                                                                                Settings

                                                                                Member Visibility
                                                                                +trilium
                                                                                trilium
                                                                                  Preparing search index...

                                                                                  trilium

                                                                                  Hierarchy Summary

                                                                                  Settings

                                                                                  Member Visibility
                                                                                  diff --git a/docs/backend_api/interfaces/Backend_Script_API.Api.html b/docs/backend_api/interfaces/Backend_Script_API.Api.html index 7656d0dc5..8a22dcfb4 100644 --- a/docs/backend_api/interfaces/Backend_Script_API.Api.html +++ b/docs/backend_api/interfaces/Backend_Script_API.Api.html @@ -1,4 +1,4 @@ -Api | trilium
                                                                                  trilium
                                                                                    Preparing search index...

                                                                                    Interface Api

                                                                                    interface Api {
                                                                                        __private: { becca: default };
                                                                                        axios: AxiosStatic;
                                                                                        cheerio: {
                                                                                            default: CheerioAPI;
                                                                                            version: string;
                                                                                            contains(container: Element, contained: Element): boolean;
                                                                                            html(options?: CheerioParserOptions): string;
                                                                                            html(
                                                                                                dom: string | Element | Cheerio,
                                                                                                options?: CheerioParserOptions,
                                                                                            ): string;
                                                                                            load(
                                                                                                html: string | Buffer<ArrayBufferLike>,
                                                                                                options?: CheerioParserOptions,
                                                                                            ): Root;
                                                                                            load(element: Element | Element[], options?: CheerioParserOptions): Root;
                                                                                            parseHTML(
                                                                                                data: string,
                                                                                                context?: null | Document,
                                                                                                keepScripts?: boolean,
                                                                                            ): Document[];
                                                                                            root(): Cheerio;
                                                                                            xml(dom?: string | Element | Cheerio): string;
                                                                                        };
                                                                                        currentNote: BNote;
                                                                                        dayjs: __module;
                                                                                        logMessages: Record<string, string[]>;
                                                                                        logSpacedUpdates: Record<string, SpacedUpdate>;
                                                                                        originEntity?: null | AbstractBeccaEntity<any>;
                                                                                        sql: any;
                                                                                        startNote?: null | BNote;
                                                                                        xml2js: node_modules/@types/xml2js;
                                                                                        backupNow(backupName: string): Promise<string>;
                                                                                        createDataNote(
                                                                                            parentNoteId: string,
                                                                                            title: string,
                                                                                            content: {},
                                                                                        ): NoteAndBranch;
                                                                                        createNewNote(params: NoteParams): NoteAndBranch;
                                                                                        createNote(
                                                                                            parentNoteId: string,
                                                                                            title: string,
                                                                                            content: string,
                                                                                            extraOptions: Omit<
                                                                                                NoteParams,
                                                                                                "title"
                                                                                                | "parentNoteId"
                                                                                                | "content"
                                                                                                | "type",
                                                                                            > & { attributes?: AttributeRow[]; json?: boolean },
                                                                                        ): NoteAndBranch;
                                                                                        createOrUpdateLauncher(
                                                                                            opts: {
                                                                                                icon: string;
                                                                                                id: string;
                                                                                                isVisible: boolean;
                                                                                                keyboardShortcut: string;
                                                                                                scriptNoteId: string;
                                                                                                targetNoteId: string;
                                                                                                title: string;
                                                                                                type: "script" | "note" | "customWidget";
                                                                                                widgetNoteId?: string;
                                                                                            },
                                                                                        ): { note: BNote };
                                                                                        createTextNote(
                                                                                            parentNoteId: string,
                                                                                            title: string,
                                                                                            content: string,
                                                                                        ): NoteAndBranch;
                                                                                        ensureNoteIsAbsentFromParent(noteId: string, parentNoteId: string): void;
                                                                                        ensureNoteIsPresentInParent(
                                                                                            noteId: string,
                                                                                            parentNoteId: string,
                                                                                            prefix: string,
                                                                                        ): { branch: null | BBranch };
                                                                                        escapeHtml(string: string): string;
                                                                                        exportSubtreeToZipFile(
                                                                                            noteId: string,
                                                                                            format: "html" | "markdown",
                                                                                            zipFilePath: string,
                                                                                        ): Promise<void>;
                                                                                        getAppInfo(): {
                                                                                            appVersion: string;
                                                                                            buildDate: string;
                                                                                            buildRevision: string;
                                                                                            clipperProtocolVersion: string;
                                                                                            dataDirectory: string;
                                                                                            dbVersion: number;
                                                                                            nodeVersion: string;
                                                                                            syncVersion: number;
                                                                                            utcDateTime: string;
                                                                                        };
                                                                                        getAttachment(attachmentId: string): null | BAttachment;
                                                                                        getAttribute(attachmentId: string): null | BAttribute;
                                                                                        getAttribute(attributeId: string): null | BAttribute;
                                                                                        getBranch(branchId: string): null | BBranch;
                                                                                        getDayNote(date: string, rootNote?: BNote): Promise<null | BNote>;
                                                                                        getEtapiToken(etapiTokenId: string): null | BEtapiToken;
                                                                                        getEtapiTokens(): BEtapiToken[];
                                                                                        getInstanceName(): null | string;
                                                                                        getMonthNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                                        getNote(noteId: string): null | BNote;
                                                                                        getNotesWithLabel(name: string, value?: string): BNote[];
                                                                                        getNoteWithLabel(name: string, value?: string): null | BNote;
                                                                                        getOption(optionName: string): null | BOption;
                                                                                        getOptions(): BOption[];
                                                                                        getQuarterNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                                        getRevision(revisionId: string): null | BRevision;
                                                                                        getRootCalendarNote(): null | BNote;
                                                                                        getTodayNote(rootNote?: BNote): Promise<null | BNote>;
                                                                                        getWeekFirstDayNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                                        getWeekNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                                        getYearNote(year: string, rootNote?: BNote): null | BNote;
                                                                                        log(message: string): void;
                                                                                        randomString(length: number): string;
                                                                                        runOnFrontend(script: () => string | void, params: []): void;
                                                                                        runOutsideOfSync(callback: () => void): Promise<void>;
                                                                                        searchForNote(query: string, searchParams: SearchParams): null | BNote;
                                                                                        searchForNotes(query: string, searchParams: SearchParams): BNote[];
                                                                                        setNoteToParent(
                                                                                            noteId: string,
                                                                                            prefix: string,
                                                                                            parentNoteId: null | string,
                                                                                        ): void;
                                                                                        sortNotes(
                                                                                            parentNoteId: string,
                                                                                            sortConfig: { foldersFirst?: boolean; reverse?: boolean; sortBy?: string },
                                                                                        ): void;
                                                                                        toggleNoteInParent(
                                                                                            present: true,
                                                                                            noteId: string,
                                                                                            parentNoteId: string,
                                                                                            prefix: string,
                                                                                        ): void;
                                                                                        transactional(func: () => void): any;
                                                                                        unescapeHtml(string: string): string;
                                                                                    }
                                                                                    Index

                                                                                    Properties

                                                                                    __private +Api | trilium
                                                                                    trilium
                                                                                      Preparing search index...

                                                                                      Interface Api

                                                                                      interface Api {
                                                                                          __private: { becca: default };
                                                                                          axios: AxiosStatic;
                                                                                          cheerio: {
                                                                                              default: CheerioAPI;
                                                                                              version: string;
                                                                                              contains(container: Element, contained: Element): boolean;
                                                                                              html(options?: CheerioParserOptions): string;
                                                                                              html(
                                                                                                  dom: string | Element | Cheerio,
                                                                                                  options?: CheerioParserOptions,
                                                                                              ): string;
                                                                                              load(
                                                                                                  html: string | Buffer<ArrayBufferLike>,
                                                                                                  options?: CheerioParserOptions,
                                                                                              ): Root;
                                                                                              load(element: Element | Element[], options?: CheerioParserOptions): Root;
                                                                                              parseHTML(
                                                                                                  data: string,
                                                                                                  context?: null | Document,
                                                                                                  keepScripts?: boolean,
                                                                                              ): Document[];
                                                                                              root(): Cheerio;
                                                                                              xml(dom?: string | Element | Cheerio): string;
                                                                                          };
                                                                                          currentNote: BNote;
                                                                                          dayjs: __module;
                                                                                          logMessages: Record<string, string[]>;
                                                                                          logSpacedUpdates: Record<string, SpacedUpdate>;
                                                                                          originEntity?: null | AbstractBeccaEntity<any>;
                                                                                          sql: any;
                                                                                          startNote?: null | BNote;
                                                                                          xml2js: node_modules/@types/xml2js;
                                                                                          backupNow(backupName: string): Promise<string>;
                                                                                          createDataNote(
                                                                                              parentNoteId: string,
                                                                                              title: string,
                                                                                              content: {},
                                                                                          ): NoteAndBranch;
                                                                                          createNewNote(params: NoteParams): NoteAndBranch;
                                                                                          createNote(
                                                                                              parentNoteId: string,
                                                                                              title: string,
                                                                                              content: string,
                                                                                              extraOptions: Omit<
                                                                                                  NoteParams,
                                                                                                  "title"
                                                                                                  | "parentNoteId"
                                                                                                  | "content"
                                                                                                  | "type",
                                                                                              > & { attributes?: AttributeRow[]; json?: boolean },
                                                                                          ): NoteAndBranch;
                                                                                          createOrUpdateLauncher(
                                                                                              opts: {
                                                                                                  icon: string;
                                                                                                  id: string;
                                                                                                  isVisible: boolean;
                                                                                                  keyboardShortcut: string;
                                                                                                  scriptNoteId: string;
                                                                                                  targetNoteId: string;
                                                                                                  title: string;
                                                                                                  type: "script" | "note" | "customWidget";
                                                                                                  widgetNoteId?: string;
                                                                                              },
                                                                                          ): { note: BNote };
                                                                                          createTextNote(
                                                                                              parentNoteId: string,
                                                                                              title: string,
                                                                                              content: string,
                                                                                          ): NoteAndBranch;
                                                                                          ensureNoteIsAbsentFromParent(noteId: string, parentNoteId: string): void;
                                                                                          ensureNoteIsPresentInParent(
                                                                                              noteId: string,
                                                                                              parentNoteId: string,
                                                                                              prefix: string,
                                                                                          ): { branch: null | BBranch };
                                                                                          escapeHtml(string: string): string;
                                                                                          exportSubtreeToZipFile(
                                                                                              noteId: string,
                                                                                              format: "html" | "markdown",
                                                                                              zipFilePath: string,
                                                                                          ): Promise<void>;
                                                                                          getAppInfo(): {
                                                                                              appVersion: string;
                                                                                              buildDate: string;
                                                                                              buildRevision: string;
                                                                                              clipperProtocolVersion: string;
                                                                                              dataDirectory: string;
                                                                                              dbVersion: number;
                                                                                              nodeVersion: string;
                                                                                              syncVersion: number;
                                                                                              utcDateTime: string;
                                                                                          };
                                                                                          getAttachment(attachmentId: string): null | BAttachment;
                                                                                          getAttribute(attachmentId: string): null | BAttribute;
                                                                                          getAttribute(attributeId: string): null | BAttribute;
                                                                                          getBranch(branchId: string): null | BBranch;
                                                                                          getDayNote(date: string, rootNote?: BNote): Promise<null | BNote>;
                                                                                          getEtapiToken(etapiTokenId: string): null | BEtapiToken;
                                                                                          getEtapiTokens(): BEtapiToken[];
                                                                                          getInstanceName(): null | string;
                                                                                          getMonthNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                                          getNote(noteId: string): null | BNote;
                                                                                          getNotesWithLabel(name: string, value?: string): BNote[];
                                                                                          getNoteWithLabel(name: string, value?: string): null | BNote;
                                                                                          getOption(optionName: string): null | BOption;
                                                                                          getOptions(): BOption[];
                                                                                          getQuarterNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                                          getRevision(revisionId: string): null | BRevision;
                                                                                          getRootCalendarNote(): null | BNote;
                                                                                          getTodayNote(rootNote?: BNote): Promise<null | BNote>;
                                                                                          getWeekFirstDayNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                                          getWeekNote(date: string, rootNote: BNote): Promise<null | BNote>;
                                                                                          getYearNote(year: string, rootNote?: BNote): null | BNote;
                                                                                          log(message: string): void;
                                                                                          randomString(length: number): string;
                                                                                          runOnFrontend(script: () => string | void, params: []): void;
                                                                                          runOutsideOfSync(callback: () => void): Promise<void>;
                                                                                          searchForNote(query: string, searchParams: SearchParams): null | BNote;
                                                                                          searchForNotes(query: string, searchParams: SearchParams): BNote[];
                                                                                          setNoteToParent(
                                                                                              noteId: string,
                                                                                              prefix: string,
                                                                                              parentNoteId: null | string,
                                                                                          ): void;
                                                                                          sortNotes(
                                                                                              parentNoteId: string,
                                                                                              sortConfig: { foldersFirst?: boolean; reverse?: boolean; sortBy?: string },
                                                                                          ): void;
                                                                                          toggleNoteInParent(
                                                                                              present: true,
                                                                                              noteId: string,
                                                                                              parentNoteId: string,
                                                                                              prefix: string,
                                                                                          ): void;
                                                                                          transactional(func: () => void): any;
                                                                                          unescapeHtml(string: string): string;
                                                                                      }
                                                                                      Index

                                                                                      Properties

                                                                                      __private axios cheerio currentNote @@ -53,29 +53,29 @@ unescapeHtml

                                                                                      Properties

                                                                                      __private

                                                                                      __private: { becca: default }

                                                                                      This object contains "at your risk" and "no BC guarantees" objects for advanced use cases.

                                                                                      Type declaration

                                                                                      • becca: default

                                                                                        provides access to the backend in-memory object graph, see Becca

                                                                                        -
                                                                                      axios: AxiosStatic

                                                                                      Axios library for HTTP requests. See https://axios-http.com for documentation

                                                                                      +
                                                                                      axios: AxiosStatic

                                                                                      Axios library for HTTP requests. See https://axios-http.com for documentation

                                                                                      use native (browser compatible) fetch() instead

                                                                                      -
                                                                                      cheerio: {
                                                                                          default: CheerioAPI;
                                                                                          version: string;
                                                                                          contains(container: Element, contained: Element): boolean;
                                                                                          html(options?: CheerioParserOptions): string;
                                                                                          html(
                                                                                              dom: string | Element | Cheerio,
                                                                                              options?: CheerioParserOptions,
                                                                                          ): string;
                                                                                          load(
                                                                                              html: string | Buffer<ArrayBufferLike>,
                                                                                              options?: CheerioParserOptions,
                                                                                          ): Root;
                                                                                          load(element: Element | Element[], options?: CheerioParserOptions): Root;
                                                                                          parseHTML(
                                                                                              data: string,
                                                                                              context?: null | Document,
                                                                                              keepScripts?: boolean,
                                                                                          ): Document[];
                                                                                          root(): Cheerio;
                                                                                          xml(dom?: string | Element | Cheerio): string;
                                                                                      }

                                                                                      cheerio library for HTML parsing and manipulation. See https://cheerio.js.org for documentation

                                                                                      -
                                                                                      currentNote: BNote

                                                                                      Note where the script is currently executing. This comes into play when your script is spread in multiple code +

                                                                                      cheerio: {
                                                                                          default: CheerioAPI;
                                                                                          version: string;
                                                                                          contains(container: Element, contained: Element): boolean;
                                                                                          html(options?: CheerioParserOptions): string;
                                                                                          html(
                                                                                              dom: string | Element | Cheerio,
                                                                                              options?: CheerioParserOptions,
                                                                                          ): string;
                                                                                          load(
                                                                                              html: string | Buffer<ArrayBufferLike>,
                                                                                              options?: CheerioParserOptions,
                                                                                          ): Root;
                                                                                          load(element: Element | Element[], options?: CheerioParserOptions): Root;
                                                                                          parseHTML(
                                                                                              data: string,
                                                                                              context?: null | Document,
                                                                                              keepScripts?: boolean,
                                                                                          ): Document[];
                                                                                          root(): Cheerio;
                                                                                          xml(dom?: string | Element | Cheerio): string;
                                                                                      }

                                                                                      cheerio library for HTML parsing and manipulation. See https://cheerio.js.org for documentation

                                                                                      +
                                                                                      currentNote: BNote

                                                                                      Note where the script is currently executing. This comes into play when your script is spread in multiple code notes, the script starts in "startNote", but then through function calls may jump into another note (currentNote). A similar concept in C would be FILE Don't mix this up with the concept of active note.

                                                                                      -
                                                                                      dayjs: __module

                                                                                      day.js library for date manipulation. See https://day.js.org for documentation

                                                                                      -
                                                                                      logMessages: Record<string, string[]>
                                                                                      logSpacedUpdates: Record<string, SpacedUpdate>
                                                                                      originEntity?: null | AbstractBeccaEntity<any>

                                                                                      Entity whose event triggered this execution

                                                                                      -
                                                                                      sql: any

                                                                                      sql

                                                                                      -
                                                                                      startNote?: null | BNote

                                                                                      Note where the script started executing (entrypoint). +

                                                                                      dayjs: __module

                                                                                      day.js library for date manipulation. See https://day.js.org for documentation

                                                                                      +
                                                                                      logMessages: Record<string, string[]>
                                                                                      logSpacedUpdates: Record<string, SpacedUpdate>
                                                                                      originEntity?: null | AbstractBeccaEntity<any>

                                                                                      Entity whose event triggered this execution

                                                                                      +
                                                                                      sql: any

                                                                                      sql

                                                                                      +
                                                                                      startNote?: null | BNote

                                                                                      Note where the script started executing (entrypoint). As an analogy, in C this would be the file which contains the main() function of the current process.

                                                                                      -
                                                                                      xml2js: node_modules/@types/xml2js

                                                                                      xml2js library for XML parsing. See https://github.com/Leonidas-from-XIV/node-xml2js for documentation

                                                                                      -

                                                                                      Methods

                                                                                      • Parameters

                                                                                      xml2js: node_modules/@types/xml2js

                                                                                      xml2js library for XML parsing. See https://github.com/Leonidas-from-XIV/node-xml2js for documentation

                                                                                      +

                                                                                      Methods

                                                                                      • Parameters

                                                                                        • backupName: string

                                                                                          If the backupName is e.g. "now", then the backup will be written to "backup-now.db" file

                                                                                        Returns Promise<string>

                                                                                        resolves once the backup is finished

                                                                                        -

                                                                                      • Create data note - data in this context means object serializable to JSON. Created note will be of type 'code' and JSON MIME type. See also createNewNote() for more options.

                                                                                        -

                                                                                        Parameters

                                                                                        • parentNoteId: string
                                                                                        • title: string
                                                                                        • content: {}

                                                                                        Returns NoteAndBranch

                                                                                      • Parameters

                                                                                      • Parameters

                                                                                        • parentNoteId: string

                                                                                          create new note under this parent

                                                                                        • title: string
                                                                                        • content: string
                                                                                        • extraOptions: Omit<NoteParams, "title" | "parentNoteId" | "content" | "type"> & {
                                                                                              attributes?: AttributeRow[];
                                                                                              json?: boolean;
                                                                                          }
                                                                                          • Optionalattributes?: AttributeRow[]
                                                                                          • Optionaljson?: boolean

                                                                                            should the note be JSON

                                                                                        Returns NoteAndBranch

                                                                                        object contains newly created entities note and branch

                                                                                        please use createTextNote() with similar API for simpler use cases or createNewNote() for more complex needs

                                                                                        -

                                                                                      • Creates a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.

                                                                                        +

                                                                                      • Creates a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.

                                                                                        Parameters

                                                                                        • opts: {
                                                                                              icon: string;
                                                                                              id: string;
                                                                                              isVisible: boolean;
                                                                                              keyboardShortcut: string;
                                                                                              scriptNoteId: string;
                                                                                              targetNoteId: string;
                                                                                              title: string;
                                                                                              type: "script" | "note" | "customWidget";
                                                                                              widgetNoteId?: string;
                                                                                          }
                                                                                          • icon: string

                                                                                            name of the boxicon to be used (e.g. "bx-time")

                                                                                          • id: string

                                                                                            id of the launcher, only alphanumeric at least 6 characters long

                                                                                          • isVisible: boolean

                                                                                            if true, will be created in the "Visible launchers", otherwise in "Available launchers"

                                                                                            @@ -89,76 +89,76 @@ JSON MIME type. See also createNewNote() for more options.

                                                                                          • "customWidget" - the launcher will be rendered with a custom widget (specified in widgetNoteId param)
                                                                                      • OptionalwidgetNoteId?: string

                                                                                        for type "customWidget"

                                                                                        -

                                                                                      Returns { note: BNote }

                                                                                      • If there's a branch between note and parent note, remove it. Otherwise, do nothing.

                                                                                        -

                                                                                        Parameters

                                                                                        • noteId: string
                                                                                        • parentNoteId: string

                                                                                        Returns void

                                                                                      • If there's no branch between note and parent note, create one. Otherwise, do nothing. Returns the new or existing branch.

                                                                                        +

                                                                                      Returns { note: BNote }

                                                                                      • If there's a branch between note and parent note, remove it. Otherwise, do nothing.

                                                                                        +

                                                                                        Parameters

                                                                                        • noteId: string
                                                                                        • parentNoteId: string

                                                                                        Returns void

                                                                                      • If there's no branch between note and parent note, create one. Otherwise, do nothing. Returns the new or existing branch.

                                                                                        Parameters

                                                                                        • noteId: string
                                                                                        • parentNoteId: string
                                                                                        • prefix: string

                                                                                          if branch is created between note and parent note, set this prefix

                                                                                          -

                                                                                        Returns { branch: null | BBranch }

                                                                                      • Parameters

                                                                                        • noteId: string
                                                                                        • format: "html" | "markdown"

                                                                                          either 'html' or 'markdown'

                                                                                          -
                                                                                        • zipFilePath: string

                                                                                        Returns Promise<void>

                                                                                      • Returns {
                                                                                            appVersion: string;
                                                                                            buildDate: string;
                                                                                            buildRevision: string;
                                                                                            clipperProtocolVersion: string;
                                                                                            dataDirectory: string;
                                                                                            dbVersion: number;
                                                                                            nodeVersion: string;
                                                                                            syncVersion: number;
                                                                                            utcDateTime: string;
                                                                                        }

                                                                                      • Returns day note for given date. If such note doesn't exist, it is created.

                                                                                        +

                                                                                      Returns { branch: null | BBranch }

                                                                                      Returns Promise<null | BNote>

                                                                                      Returns Promise<null | BNote>

                                                                                      Returns BNote[]

                                                                                      Returns null | BNote

                                                                                      Returns Promise<null | BNote>

                                                                                      Returns Promise<null | BNote>

                                                                                      Returns Promise<null | BNote>

                                                                                      Returns Promise<null | BNote>

                                                                                      Returns null | BNote

                                                                                      Returns void

                                                                                      Returns void

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Properties
                                                                                      Methods
                                                                                      +

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Properties
                                                                                      Methods
                                                                                      diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AsyncResourceOptions.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.AsyncResourceOptions.html index 4a8f9c61f..4e83d7106 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.AsyncResourceOptions.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.AsyncResourceOptions.html @@ -1,4 +1,4 @@ -AsyncResourceOptions | trilium
                                                                                      trilium
                                                                                        Preparing search index...

                                                                                        Interface AsyncResourceOptions

                                                                                        interface AsyncResourceOptions {
                                                                                            requireManualDestroy?: boolean;
                                                                                            triggerAsyncId?: number;
                                                                                        }

                                                                                        Hierarchy (View Summary)

                                                                                        Index

                                                                                        Properties

                                                                                        requireManualDestroy? +AsyncResourceOptions | trilium
                                                                                        trilium
                                                                                          Preparing search index...

                                                                                          Interface AsyncResourceOptions

                                                                                          interface AsyncResourceOptions {
                                                                                              requireManualDestroy?: boolean;
                                                                                              triggerAsyncId?: number;
                                                                                          }

                                                                                          Hierarchy (View Summary)

                                                                                          Index

                                                                                          Properties

                                                                                          requireManualDestroy? triggerAsyncId?

                                                                                          Properties

                                                                                          requireManualDestroy?: boolean

                                                                                          Disables automatic emitDestroy when the object is garbage collected. This usually does not need to be set (even if emitDestroy is called diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AttachmentOpts.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.AttachmentOpts.html index 847b1b238..dddb266bd 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.AttachmentOpts.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.AttachmentOpts.html @@ -1,2 +1,2 @@ -AttachmentOpts | trilium

                                                                                          trilium
                                                                                            Preparing search index...

                                                                                            Interface AttachmentOpts

                                                                                            interface AttachmentOpts {
                                                                                                includeContentLength?: boolean;
                                                                                            }
                                                                                            Index

                                                                                            Properties

                                                                                            includeContentLength? -

                                                                                            Properties

                                                                                            includeContentLength?: boolean

                                                                                            Settings

                                                                                            Member Visibility

                                                                                            On This Page

                                                                                            Properties
                                                                                            +AttachmentOpts | trilium
                                                                                            trilium
                                                                                              Preparing search index...

                                                                                              Interface AttachmentOpts

                                                                                              interface AttachmentOpts {
                                                                                                  includeContentLength?: boolean;
                                                                                              }
                                                                                              Index

                                                                                              Properties

                                                                                              includeContentLength? +

                                                                                              Properties

                                                                                              includeContentLength?: boolean

                                                                                              Settings

                                                                                              Member Visibility

                                                                                              On This Page

                                                                                              Properties
                                                                                              diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AttachmentRow.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.AttachmentRow.html index a39c597f7..87b2f0327 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.AttachmentRow.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.AttachmentRow.html @@ -1,4 +1,4 @@ -AttachmentRow | trilium
                                                                                              trilium
                                                                                                Preparing search index...

                                                                                                Interface AttachmentRow

                                                                                                interface AttachmentRow {
                                                                                                    attachmentId?: string;
                                                                                                    blobId?: string;
                                                                                                    content?: string | Buffer<ArrayBufferLike>;
                                                                                                    contentLength?: number;
                                                                                                    dateModified?: string;
                                                                                                    deleteId?: string;
                                                                                                    isDeleted?: boolean;
                                                                                                    isProtected?: boolean;
                                                                                                    mime: string;
                                                                                                    ownerId?: string;
                                                                                                    position?: number;
                                                                                                    role: string;
                                                                                                    title: string;
                                                                                                    utcDateModified?: string;
                                                                                                    utcDateScheduledForErasureSince?: string;
                                                                                                }
                                                                                                Index

                                                                                                Properties

                                                                                                attachmentId? +AttachmentRow | trilium
                                                                                                trilium
                                                                                                  Preparing search index...

                                                                                                  Interface AttachmentRow

                                                                                                  interface AttachmentRow {
                                                                                                      attachmentId?: string;
                                                                                                      blobId?: string;
                                                                                                      content?: string | Buffer<ArrayBufferLike>;
                                                                                                      contentLength?: number;
                                                                                                      dateModified?: string;
                                                                                                      deleteId?: string;
                                                                                                      isDeleted?: boolean;
                                                                                                      isProtected?: boolean;
                                                                                                      mime: string;
                                                                                                      ownerId?: string;
                                                                                                      position?: number;
                                                                                                      role: string;
                                                                                                      title: string;
                                                                                                      utcDateModified?: string;
                                                                                                      utcDateScheduledForErasureSince?: string;
                                                                                                  }
                                                                                                  Index

                                                                                                  Properties

                                                                                                  attachmentId? blobId? content? contentLength? @@ -13,4 +13,4 @@ title utcDateModified? utcDateScheduledForErasureSince? -

                                                                                                  Properties

                                                                                                  attachmentId?: string
                                                                                                  blobId?: string

                                                                                                  Optionalcontent

                                                                                                  content?: string | Buffer<ArrayBufferLike>
                                                                                                  contentLength?: number
                                                                                                  dateModified?: string
                                                                                                  deleteId?: string
                                                                                                  isDeleted?: boolean
                                                                                                  isProtected?: boolean
                                                                                                  mime: string
                                                                                                  ownerId?: string
                                                                                                  position?: number
                                                                                                  role: string
                                                                                                  title: string
                                                                                                  utcDateModified?: string
                                                                                                  utcDateScheduledForErasureSince?: string

                                                                                                  Settings

                                                                                                  Member Visibility

                                                                                                  On This Page

                                                                                                  Properties
                                                                                                  +

                                                                                                  Properties

                                                                                                  attachmentId?: string
                                                                                                  blobId?: string

                                                                                                  Optionalcontent

                                                                                                  content?: string | Buffer<ArrayBufferLike>
                                                                                                  contentLength?: number
                                                                                                  dateModified?: string
                                                                                                  deleteId?: string
                                                                                                  isDeleted?: boolean
                                                                                                  isProtected?: boolean
                                                                                                  mime: string
                                                                                                  ownerId?: string
                                                                                                  position?: number
                                                                                                  role: string
                                                                                                  title: string
                                                                                                  utcDateModified?: string
                                                                                                  utcDateScheduledForErasureSince?: string

                                                                                                  Settings

                                                                                                  Member Visibility

                                                                                                  On This Page

                                                                                                  Properties
                                                                                                  diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AttributeRow.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.AttributeRow.html index 94ecac1ec..122a1c467 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.AttributeRow.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.AttributeRow.html @@ -1,4 +1,4 @@ -AttributeRow | trilium
                                                                                                  trilium
                                                                                                    Preparing search index...

                                                                                                    Interface AttributeRow

                                                                                                    interface AttributeRow {
                                                                                                        attributeId?: string;
                                                                                                        isInheritable?: boolean;
                                                                                                        name: string;
                                                                                                        noteId?: string;
                                                                                                        position?: null | number;
                                                                                                        type: AttributeType;
                                                                                                        utcDateModified?: string;
                                                                                                        value?: string;
                                                                                                    }
                                                                                                    Index

                                                                                                    Properties

                                                                                                    attributeId? +AttributeRow | trilium
                                                                                                    trilium
                                                                                                      Preparing search index...

                                                                                                      Interface AttributeRow

                                                                                                      interface AttributeRow {
                                                                                                          attributeId?: string;
                                                                                                          isInheritable?: boolean;
                                                                                                          name: string;
                                                                                                          noteId?: string;
                                                                                                          position?: null | number;
                                                                                                          type: AttributeType;
                                                                                                          utcDateModified?: string;
                                                                                                          value?: string;
                                                                                                      }
                                                                                                      Index

                                                                                                      Properties

                                                                                                      attributeId? isInheritable? name noteId? @@ -6,4 +6,4 @@ type utcDateModified? value? -

                                                                                                      Properties

                                                                                                      attributeId?: string
                                                                                                      isInheritable?: boolean
                                                                                                      name: string
                                                                                                      noteId?: string
                                                                                                      position?: null | number
                                                                                                      type: AttributeType
                                                                                                      utcDateModified?: string
                                                                                                      value?: string

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      On This Page

                                                                                                      Properties
                                                                                                      +

                                                                                                      Properties

                                                                                                      attributeId?: string
                                                                                                      isInheritable?: boolean
                                                                                                      name: string
                                                                                                      noteId?: string
                                                                                                      position?: null | number
                                                                                                      type: AttributeType
                                                                                                      utcDateModified?: string
                                                                                                      value?: string

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      On This Page

                                                                                                      Properties
                                                                                                      diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosDefaults.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosDefaults.html index 6d2c20929..ed3ebe60d 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosDefaults.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosDefaults.html @@ -1,5 +1,5 @@ AxiosDefaults | trilium
                                                                                                      trilium
                                                                                                        Preparing search index...

                                                                                                        Interface AxiosDefaults<D>

                                                                                                        Construct a type with the properties of T except for those in type K.

                                                                                                        -
                                                                                                        interface AxiosDefaults<D = any> {
                                                                                                            adapter?: AxiosAdapterConfig | AxiosAdapterConfig[];
                                                                                                            allowAbsoluteUrls?: boolean;
                                                                                                            auth?: AxiosBasicCredentials;
                                                                                                            baseURL?: string;
                                                                                                            beforeRedirect?: (
                                                                                                                options: Record<string, any>,
                                                                                                                responseDetails: {
                                                                                                                    headers: Record<string, string>;
                                                                                                                    statusCode: HttpStatusCode;
                                                                                                                },
                                                                                                            ) => void;
                                                                                                            cancelToken?: CancelToken;
                                                                                                            data?: D;
                                                                                                            decompress?: boolean;
                                                                                                            env?: { FormData?: new (...args: any[]) => object };
                                                                                                            family?: AddressFamily;
                                                                                                            fetchOptions?: Record<string, any>;
                                                                                                            formSerializer?: FormSerializerOptions;
                                                                                                            headers: HeadersDefaults;
                                                                                                            httpAgent?: any;
                                                                                                            httpsAgent?: any;
                                                                                                            insecureHTTPParser?: boolean;
                                                                                                            lookup?:
                                                                                                                | (
                                                                                                                    (
                                                                                                                        hostname: string,
                                                                                                                        options: object,
                                                                                                                        cb: (
                                                                                                                            err: null | Error,
                                                                                                                            address: LookupAddress | LookupAddress[],
                                                                                                                            family?: AddressFamily,
                                                                                                                        ) => void,
                                                                                                                    ) => void
                                                                                                                )
                                                                                                                | (
                                                                                                                    (
                                                                                                                        hostname: string,
                                                                                                                        options: object,
                                                                                                                    ) => Promise<
                                                                                                                        | LookupAddress
                                                                                                                        | [
                                                                                                                            address: LookupAddressEntry
                                                                                                                            | LookupAddressEntry[],
                                                                                                                            family?: AddressFamily,
                                                                                                                        ],
                                                                                                                    >
                                                                                                                );
                                                                                                            maxBodyLength?: number;
                                                                                                            maxContentLength?: number;
                                                                                                            maxRate?: number | [number, number];
                                                                                                            maxRedirects?: number;
                                                                                                            method?: string;
                                                                                                            onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                            onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                            params?: any;
                                                                                                            paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer;
                                                                                                            proxy?: false | AxiosProxyConfig;
                                                                                                            responseEncoding?: string;
                                                                                                            responseType?: ResponseType;
                                                                                                            signal?: GenericAbortSignal;
                                                                                                            socketPath?: null | string;
                                                                                                            timeout?: number;
                                                                                                            timeoutErrorMessage?: string;
                                                                                                            transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
                                                                                                            transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
                                                                                                            transitional?: TransitionalOptions;
                                                                                                            transport?: any;
                                                                                                            url?: string;
                                                                                                            validateStatus?: null | ((status: number) => boolean);
                                                                                                            withCredentials?: boolean;
                                                                                                            withXSRFToken?:
                                                                                                                | boolean
                                                                                                                | ((config: InternalAxiosRequestConfig) => undefined | boolean);
                                                                                                            xsrfCookieName?: string;
                                                                                                            xsrfHeaderName?: string;
                                                                                                        }

                                                                                                        Type Parameters

                                                                                                        • D = any

                                                                                                        Hierarchy (View Summary)

                                                                                                        Index

                                                                                                        Properties

                                                                                                        adapter? +
                                                                                                        interface AxiosDefaults<D = any> {
                                                                                                            adapter?: AxiosAdapterConfig | AxiosAdapterConfig[];
                                                                                                            allowAbsoluteUrls?: boolean;
                                                                                                            auth?: AxiosBasicCredentials;
                                                                                                            baseURL?: string;
                                                                                                            beforeRedirect?: (
                                                                                                                options: Record<string, any>,
                                                                                                                responseDetails: {
                                                                                                                    headers: Record<string, string>;
                                                                                                                    statusCode: HttpStatusCode;
                                                                                                                },
                                                                                                            ) => void;
                                                                                                            cancelToken?: CancelToken;
                                                                                                            data?: D;
                                                                                                            decompress?: boolean;
                                                                                                            env?: { FormData?: new (...args: any[]) => object };
                                                                                                            family?: AddressFamily;
                                                                                                            fetchOptions?: Record<string, any>;
                                                                                                            formSerializer?: FormSerializerOptions;
                                                                                                            headers: HeadersDefaults;
                                                                                                            httpAgent?: any;
                                                                                                            httpsAgent?: any;
                                                                                                            insecureHTTPParser?: boolean;
                                                                                                            lookup?:
                                                                                                                | (
                                                                                                                    (
                                                                                                                        hostname: string,
                                                                                                                        options: object,
                                                                                                                        cb: (
                                                                                                                            err: null | Error,
                                                                                                                            address: LookupAddress | LookupAddress[],
                                                                                                                            family?: AddressFamily,
                                                                                                                        ) => void,
                                                                                                                    ) => void
                                                                                                                )
                                                                                                                | (
                                                                                                                    (
                                                                                                                        hostname: string,
                                                                                                                        options: object,
                                                                                                                    ) => Promise<
                                                                                                                        | LookupAddress
                                                                                                                        | [
                                                                                                                            address: LookupAddressEntry
                                                                                                                            | LookupAddressEntry[],
                                                                                                                            family?: AddressFamily,
                                                                                                                        ],
                                                                                                                    >
                                                                                                                );
                                                                                                            maxBodyLength?: number;
                                                                                                            maxContentLength?: number;
                                                                                                            maxRate?: number | [number, number];
                                                                                                            maxRedirects?: number;
                                                                                                            method?: string;
                                                                                                            onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                            onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                            params?: any;
                                                                                                            paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer;
                                                                                                            proxy?: false | AxiosProxyConfig;
                                                                                                            responseEncoding?: string;
                                                                                                            responseType?: ResponseType;
                                                                                                            signal?: GenericAbortSignal;
                                                                                                            socketPath?: null | string;
                                                                                                            timeout?: number;
                                                                                                            timeoutErrorMessage?: string;
                                                                                                            transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
                                                                                                            transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
                                                                                                            transitional?: TransitionalOptions;
                                                                                                            transport?: any;
                                                                                                            url?: string;
                                                                                                            validateStatus?: null | ((status: number) => boolean);
                                                                                                            withCredentials?: boolean;
                                                                                                            withXSRFToken?:
                                                                                                                | boolean
                                                                                                                | ((config: InternalAxiosRequestConfig) => undefined | boolean);
                                                                                                            xsrfCookieName?: string;
                                                                                                            xsrfHeaderName?: string;
                                                                                                        }

                                                                                                        Type Parameters

                                                                                                        • D = any

                                                                                                        Hierarchy (View Summary)

                                                                                                        Index

                                                                                                        Properties

                                                                                                        adapter? allowAbsoluteUrls? auth? baseURL? diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosInstance.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosInstance.html index 2de48e116..3ae1112d1 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosInstance.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosInstance.html @@ -1,4 +1,4 @@ -AxiosInstance | trilium
                                                                                                        trilium
                                                                                                          Preparing search index...

                                                                                                          Interface AxiosInstance

                                                                                                          interface AxiosInstance {
                                                                                                              defaults: Omit<AxiosDefaults<any>, "headers"> & {
                                                                                                                  headers: HeadersDefaults & { [key: string]: AxiosHeaderValue };
                                                                                                              };
                                                                                                              interceptors: {
                                                                                                                  request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>;
                                                                                                                  response: AxiosInterceptorManager<AxiosResponse<any, any>>;
                                                                                                              };
                                                                                                              delete<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                  url: string,
                                                                                                                  config?: AxiosRequestConfig<D>,
                                                                                                              ): Promise<R>;
                                                                                                              get<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                  url: string,
                                                                                                                  config?: AxiosRequestConfig<D>,
                                                                                                              ): Promise<R>;
                                                                                                              getUri(config?: AxiosRequestConfig<any>): string;
                                                                                                              head<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                  url: string,
                                                                                                                  config?: AxiosRequestConfig<D>,
                                                                                                              ): Promise<R>;
                                                                                                              options<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                  url: string,
                                                                                                                  config?: AxiosRequestConfig<D>,
                                                                                                              ): Promise<R>;
                                                                                                              patch<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                  url: string,
                                                                                                                  data?: D,
                                                                                                                  config?: AxiosRequestConfig<D>,
                                                                                                              ): Promise<R>;
                                                                                                              patchForm<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                  url: string,
                                                                                                                  data?: D,
                                                                                                                  config?: AxiosRequestConfig<D>,
                                                                                                              ): Promise<R>;
                                                                                                              post<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                  url: string,
                                                                                                                  data?: D,
                                                                                                                  config?: AxiosRequestConfig<D>,
                                                                                                              ): Promise<R>;
                                                                                                              postForm<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                  url: string,
                                                                                                                  data?: D,
                                                                                                                  config?: AxiosRequestConfig<D>,
                                                                                                              ): Promise<R>;
                                                                                                              put<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                  url: string,
                                                                                                                  data?: D,
                                                                                                                  config?: AxiosRequestConfig<D>,
                                                                                                              ): Promise<R>;
                                                                                                              putForm<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                  url: string,
                                                                                                                  data?: D,
                                                                                                                  config?: AxiosRequestConfig<D>,
                                                                                                              ): Promise<R>;
                                                                                                              request<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                  config: AxiosRequestConfig<D>,
                                                                                                              ): Promise<R>;
                                                                                                              <T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                  config: AxiosRequestConfig<D>,
                                                                                                              ): Promise<R>;
                                                                                                              <T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                  url: string,
                                                                                                                  config?: AxiosRequestConfig<D>,
                                                                                                              ): Promise<R>;
                                                                                                          }

                                                                                                          Hierarchy (View Summary)

                                                                                                          Index

                                                                                                          Properties

                                                                                                          defaults +AxiosInstance | trilium
                                                                                                          trilium
                                                                                                            Preparing search index...

                                                                                                            Interface AxiosInstance

                                                                                                            interface AxiosInstance {
                                                                                                                defaults: Omit<AxiosDefaults<any>, "headers"> & {
                                                                                                                    headers: HeadersDefaults & { [key: string]: AxiosHeaderValue };
                                                                                                                };
                                                                                                                interceptors: {
                                                                                                                    request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>;
                                                                                                                    response: AxiosInterceptorManager<AxiosResponse<any, any>>;
                                                                                                                };
                                                                                                                delete<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                    url: string,
                                                                                                                    config?: AxiosRequestConfig<D>,
                                                                                                                ): Promise<R>;
                                                                                                                get<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                    url: string,
                                                                                                                    config?: AxiosRequestConfig<D>,
                                                                                                                ): Promise<R>;
                                                                                                                getUri(config?: AxiosRequestConfig<any>): string;
                                                                                                                head<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                    url: string,
                                                                                                                    config?: AxiosRequestConfig<D>,
                                                                                                                ): Promise<R>;
                                                                                                                options<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                    url: string,
                                                                                                                    config?: AxiosRequestConfig<D>,
                                                                                                                ): Promise<R>;
                                                                                                                patch<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                    url: string,
                                                                                                                    data?: D,
                                                                                                                    config?: AxiosRequestConfig<D>,
                                                                                                                ): Promise<R>;
                                                                                                                patchForm<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                    url: string,
                                                                                                                    data?: D,
                                                                                                                    config?: AxiosRequestConfig<D>,
                                                                                                                ): Promise<R>;
                                                                                                                post<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                    url: string,
                                                                                                                    data?: D,
                                                                                                                    config?: AxiosRequestConfig<D>,
                                                                                                                ): Promise<R>;
                                                                                                                postForm<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                    url: string,
                                                                                                                    data?: D,
                                                                                                                    config?: AxiosRequestConfig<D>,
                                                                                                                ): Promise<R>;
                                                                                                                put<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                    url: string,
                                                                                                                    data?: D,
                                                                                                                    config?: AxiosRequestConfig<D>,
                                                                                                                ): Promise<R>;
                                                                                                                putForm<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                    url: string,
                                                                                                                    data?: D,
                                                                                                                    config?: AxiosRequestConfig<D>,
                                                                                                                ): Promise<R>;
                                                                                                                request<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                    config: AxiosRequestConfig<D>,
                                                                                                                ): Promise<R>;
                                                                                                                <T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                    config: AxiosRequestConfig<D>,
                                                                                                                ): Promise<R>;
                                                                                                                <T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                    url: string,
                                                                                                                    config?: AxiosRequestConfig<D>,
                                                                                                                ): Promise<R>;
                                                                                                            }

                                                                                                            Hierarchy (View Summary)

                                                                                                            Index

                                                                                                            Properties

                                                                                                            defaults interceptors

                                                                                                            Methods

                                                                                                            delete get diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosRequestConfig.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosRequestConfig.html index 4b096006d..2a8439f73 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosRequestConfig.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosRequestConfig.html @@ -1,4 +1,4 @@ -AxiosRequestConfig | trilium
                                                                                                            trilium
                                                                                                              Preparing search index...

                                                                                                              Interface AxiosRequestConfig<D>

                                                                                                              interface AxiosRequestConfig<D = any> {
                                                                                                                  adapter?: AxiosAdapterConfig | AxiosAdapterConfig[];
                                                                                                                  allowAbsoluteUrls?: boolean;
                                                                                                                  auth?: AxiosBasicCredentials;
                                                                                                                  baseURL?: string;
                                                                                                                  beforeRedirect?: (
                                                                                                                      options: Record<string, any>,
                                                                                                                      responseDetails: {
                                                                                                                          headers: Record<string, string>;
                                                                                                                          statusCode: HttpStatusCode;
                                                                                                                      },
                                                                                                                  ) => void;
                                                                                                                  cancelToken?: CancelToken;
                                                                                                                  data?: D;
                                                                                                                  decompress?: boolean;
                                                                                                                  env?: { FormData?: new (...args: any[]) => object };
                                                                                                                  family?: AddressFamily;
                                                                                                                  fetchOptions?: Record<string, any>;
                                                                                                                  formSerializer?: FormSerializerOptions;
                                                                                                                  headers?:
                                                                                                                      | AxiosHeaders
                                                                                                                      | Partial<
                                                                                                                          RawAxiosHeaders & {
                                                                                                                              Accept: AxiosHeaderValue;
                                                                                                                              Authorization: AxiosHeaderValue;
                                                                                                                              "Content-Encoding": AxiosHeaderValue;
                                                                                                                              "Content-Length": AxiosHeaderValue;
                                                                                                                              "User-Agent": AxiosHeaderValue;
                                                                                                                          } & { "Content-Type": ContentType },
                                                                                                                      > & Partial<
                                                                                                                          {
                                                                                                                              delete: AxiosHeaders;
                                                                                                                              get: AxiosHeaders;
                                                                                                                              head: AxiosHeaders;
                                                                                                                              link: AxiosHeaders;
                                                                                                                              options: AxiosHeaders;
                                                                                                                              patch: AxiosHeaders;
                                                                                                                              post: AxiosHeaders;
                                                                                                                              purge: AxiosHeaders;
                                                                                                                              put: AxiosHeaders;
                                                                                                                              unlink: AxiosHeaders;
                                                                                                                          } & { common: AxiosHeaders },
                                                                                                                      >;
                                                                                                                  httpAgent?: any;
                                                                                                                  httpsAgent?: any;
                                                                                                                  insecureHTTPParser?: boolean;
                                                                                                                  lookup?:
                                                                                                                      | (
                                                                                                                          (
                                                                                                                              hostname: string,
                                                                                                                              options: object,
                                                                                                                              cb: (
                                                                                                                                  err: null | Error,
                                                                                                                                  address: LookupAddress | LookupAddress[],
                                                                                                                                  family?: AddressFamily,
                                                                                                                              ) => void,
                                                                                                                          ) => void
                                                                                                                      )
                                                                                                                      | (
                                                                                                                          (
                                                                                                                              hostname: string,
                                                                                                                              options: object,
                                                                                                                          ) => Promise<
                                                                                                                              | LookupAddress
                                                                                                                              | [
                                                                                                                                  address: LookupAddressEntry
                                                                                                                                  | LookupAddressEntry[],
                                                                                                                                  family?: AddressFamily,
                                                                                                                              ],
                                                                                                                          >
                                                                                                                      );
                                                                                                                  maxBodyLength?: number;
                                                                                                                  maxContentLength?: number;
                                                                                                                  maxRate?: number | [number, number];
                                                                                                                  maxRedirects?: number;
                                                                                                                  method?: string;
                                                                                                                  onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                                  onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                                  params?: any;
                                                                                                                  paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer;
                                                                                                                  proxy?: false | AxiosProxyConfig;
                                                                                                                  responseEncoding?: string;
                                                                                                                  responseType?: ResponseType;
                                                                                                                  signal?: GenericAbortSignal;
                                                                                                                  socketPath?: null | string;
                                                                                                                  timeout?: number;
                                                                                                                  timeoutErrorMessage?: string;
                                                                                                                  transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
                                                                                                                  transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
                                                                                                                  transitional?: TransitionalOptions;
                                                                                                                  transport?: any;
                                                                                                                  url?: string;
                                                                                                                  validateStatus?: null | ((status: number) => boolean);
                                                                                                                  withCredentials?: boolean;
                                                                                                                  withXSRFToken?:
                                                                                                                      | boolean
                                                                                                                      | ((config: InternalAxiosRequestConfig) => undefined | boolean);
                                                                                                                  xsrfCookieName?: string;
                                                                                                                  xsrfHeaderName?: string;
                                                                                                              }

                                                                                                              Type Parameters

                                                                                                              • D = any

                                                                                                              Hierarchy (View Summary)

                                                                                                              Index

                                                                                                              Properties

                                                                                                              adapter? +AxiosRequestConfig | trilium
                                                                                                              trilium
                                                                                                                Preparing search index...

                                                                                                                Interface AxiosRequestConfig<D>

                                                                                                                interface AxiosRequestConfig<D = any> {
                                                                                                                    adapter?: AxiosAdapterConfig | AxiosAdapterConfig[];
                                                                                                                    allowAbsoluteUrls?: boolean;
                                                                                                                    auth?: AxiosBasicCredentials;
                                                                                                                    baseURL?: string;
                                                                                                                    beforeRedirect?: (
                                                                                                                        options: Record<string, any>,
                                                                                                                        responseDetails: {
                                                                                                                            headers: Record<string, string>;
                                                                                                                            statusCode: HttpStatusCode;
                                                                                                                        },
                                                                                                                    ) => void;
                                                                                                                    cancelToken?: CancelToken;
                                                                                                                    data?: D;
                                                                                                                    decompress?: boolean;
                                                                                                                    env?: { FormData?: new (...args: any[]) => object };
                                                                                                                    family?: AddressFamily;
                                                                                                                    fetchOptions?: Record<string, any>;
                                                                                                                    formSerializer?: FormSerializerOptions;
                                                                                                                    headers?:
                                                                                                                        | AxiosHeaders
                                                                                                                        | Partial<
                                                                                                                            RawAxiosHeaders & {
                                                                                                                                Accept: AxiosHeaderValue;
                                                                                                                                Authorization: AxiosHeaderValue;
                                                                                                                                "Content-Encoding": AxiosHeaderValue;
                                                                                                                                "Content-Length": AxiosHeaderValue;
                                                                                                                                "User-Agent": AxiosHeaderValue;
                                                                                                                            } & { "Content-Type": ContentType },
                                                                                                                        > & Partial<
                                                                                                                            {
                                                                                                                                delete: AxiosHeaders;
                                                                                                                                get: AxiosHeaders;
                                                                                                                                head: AxiosHeaders;
                                                                                                                                link: AxiosHeaders;
                                                                                                                                options: AxiosHeaders;
                                                                                                                                patch: AxiosHeaders;
                                                                                                                                post: AxiosHeaders;
                                                                                                                                purge: AxiosHeaders;
                                                                                                                                put: AxiosHeaders;
                                                                                                                                unlink: AxiosHeaders;
                                                                                                                            } & { common: AxiosHeaders },
                                                                                                                        >;
                                                                                                                    httpAgent?: any;
                                                                                                                    httpsAgent?: any;
                                                                                                                    insecureHTTPParser?: boolean;
                                                                                                                    lookup?:
                                                                                                                        | (
                                                                                                                            (
                                                                                                                                hostname: string,
                                                                                                                                options: object,
                                                                                                                                cb: (
                                                                                                                                    err: null | Error,
                                                                                                                                    address: LookupAddress | LookupAddress[],
                                                                                                                                    family?: AddressFamily,
                                                                                                                                ) => void,
                                                                                                                            ) => void
                                                                                                                        )
                                                                                                                        | (
                                                                                                                            (
                                                                                                                                hostname: string,
                                                                                                                                options: object,
                                                                                                                            ) => Promise<
                                                                                                                                | LookupAddress
                                                                                                                                | [
                                                                                                                                    address: LookupAddressEntry
                                                                                                                                    | LookupAddressEntry[],
                                                                                                                                    family?: AddressFamily,
                                                                                                                                ],
                                                                                                                            >
                                                                                                                        );
                                                                                                                    maxBodyLength?: number;
                                                                                                                    maxContentLength?: number;
                                                                                                                    maxRate?: number | [number, number];
                                                                                                                    maxRedirects?: number;
                                                                                                                    method?: string;
                                                                                                                    onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                                    onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                                    params?: any;
                                                                                                                    paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer;
                                                                                                                    proxy?: false | AxiosProxyConfig;
                                                                                                                    responseEncoding?: string;
                                                                                                                    responseType?: ResponseType;
                                                                                                                    signal?: GenericAbortSignal;
                                                                                                                    socketPath?: null | string;
                                                                                                                    timeout?: number;
                                                                                                                    timeoutErrorMessage?: string;
                                                                                                                    transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
                                                                                                                    transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
                                                                                                                    transitional?: TransitionalOptions;
                                                                                                                    transport?: any;
                                                                                                                    url?: string;
                                                                                                                    validateStatus?: null | ((status: number) => boolean);
                                                                                                                    withCredentials?: boolean;
                                                                                                                    withXSRFToken?:
                                                                                                                        | boolean
                                                                                                                        | ((config: InternalAxiosRequestConfig) => undefined | boolean);
                                                                                                                    xsrfCookieName?: string;
                                                                                                                    xsrfHeaderName?: string;
                                                                                                                }

                                                                                                                Type Parameters

                                                                                                                • D = any

                                                                                                                Hierarchy (View Summary)

                                                                                                                Index

                                                                                                                Properties

                                                                                                                adapter? allowAbsoluteUrls? auth? baseURL? diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosStatic.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosStatic.html index abdc05007..671614b7f 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosStatic.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.AxiosStatic.html @@ -1,4 +1,4 @@ -AxiosStatic | trilium
                                                                                                                trilium
                                                                                                                  Preparing search index...

                                                                                                                  Interface AxiosStatic

                                                                                                                  interface AxiosStatic {
                                                                                                                      all: <T>(values: (T | Promise<T>)[]) => Promise<T[]>;
                                                                                                                      Axios: typeof Axios;
                                                                                                                      AxiosError: typeof AxiosError;
                                                                                                                      AxiosHeaders: typeof AxiosHeaders;
                                                                                                                      Cancel: CancelStatic;
                                                                                                                      CanceledError: typeof CanceledError;
                                                                                                                      CancelToken: CancelTokenStatic;
                                                                                                                      defaults: Omit<AxiosDefaults<any>, "headers"> & {
                                                                                                                          headers: HeadersDefaults & { [key: string]: AxiosHeaderValue };
                                                                                                                      };
                                                                                                                      formToJSON: (form: GenericFormData | GenericHTMLFormElement) => object;
                                                                                                                      getAdapter: (
                                                                                                                          adapters: undefined | AxiosAdapterConfig | AxiosAdapterConfig[],
                                                                                                                      ) => AxiosAdapter;
                                                                                                                      HttpStatusCode: typeof HttpStatusCode;
                                                                                                                      interceptors: {
                                                                                                                          request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>;
                                                                                                                          response: AxiosInterceptorManager<AxiosResponse<any, any>>;
                                                                                                                      };
                                                                                                                      isAxiosError: <T = any, D = any>(
                                                                                                                          payload: any,
                                                                                                                      ) => payload is AxiosError<T, D>;
                                                                                                                      isCancel: (value: any) => value is Cancel;
                                                                                                                      mergeConfig: <D = any>(
                                                                                                                          config1: AxiosRequestConfig<D>,
                                                                                                                          config2: AxiosRequestConfig<D>,
                                                                                                                      ) => AxiosRequestConfig<D>;
                                                                                                                      spread: <T, R>(callback: (...args: T[]) => R) => (array: T[]) => R;
                                                                                                                      toFormData: (
                                                                                                                          sourceObj: object,
                                                                                                                          targetFormData?: GenericFormData,
                                                                                                                          options?: FormSerializerOptions,
                                                                                                                      ) => GenericFormData;
                                                                                                                      VERSION: string;
                                                                                                                      create(config?: CreateAxiosDefaults<any>): AxiosInstance;
                                                                                                                      delete<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                          url: string,
                                                                                                                          config?: AxiosRequestConfig<D>,
                                                                                                                      ): Promise<R>;
                                                                                                                      get<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                          url: string,
                                                                                                                          config?: AxiosRequestConfig<D>,
                                                                                                                      ): Promise<R>;
                                                                                                                      getUri(config?: AxiosRequestConfig<any>): string;
                                                                                                                      head<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                          url: string,
                                                                                                                          config?: AxiosRequestConfig<D>,
                                                                                                                      ): Promise<R>;
                                                                                                                      options<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                          url: string,
                                                                                                                          config?: AxiosRequestConfig<D>,
                                                                                                                      ): Promise<R>;
                                                                                                                      patch<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                          url: string,
                                                                                                                          data?: D,
                                                                                                                          config?: AxiosRequestConfig<D>,
                                                                                                                      ): Promise<R>;
                                                                                                                      patchForm<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                          url: string,
                                                                                                                          data?: D,
                                                                                                                          config?: AxiosRequestConfig<D>,
                                                                                                                      ): Promise<R>;
                                                                                                                      post<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                          url: string,
                                                                                                                          data?: D,
                                                                                                                          config?: AxiosRequestConfig<D>,
                                                                                                                      ): Promise<R>;
                                                                                                                      postForm<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                          url: string,
                                                                                                                          data?: D,
                                                                                                                          config?: AxiosRequestConfig<D>,
                                                                                                                      ): Promise<R>;
                                                                                                                      put<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                          url: string,
                                                                                                                          data?: D,
                                                                                                                          config?: AxiosRequestConfig<D>,
                                                                                                                      ): Promise<R>;
                                                                                                                      putForm<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                          url: string,
                                                                                                                          data?: D,
                                                                                                                          config?: AxiosRequestConfig<D>,
                                                                                                                      ): Promise<R>;
                                                                                                                      request<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                          config: AxiosRequestConfig<D>,
                                                                                                                      ): Promise<R>;
                                                                                                                      <T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                          config: AxiosRequestConfig<D>,
                                                                                                                      ): Promise<R>;
                                                                                                                      <T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                          url: string,
                                                                                                                          config?: AxiosRequestConfig<D>,
                                                                                                                      ): Promise<R>;
                                                                                                                  }

                                                                                                                  Hierarchy (View Summary)

                                                                                                                  Index

                                                                                                                  Properties

                                                                                                                  all +AxiosStatic | trilium
                                                                                                                  trilium
                                                                                                                    Preparing search index...

                                                                                                                    Interface AxiosStatic

                                                                                                                    interface AxiosStatic {
                                                                                                                        all: <T>(values: (T | Promise<T>)[]) => Promise<T[]>;
                                                                                                                        Axios: typeof Axios;
                                                                                                                        AxiosError: typeof AxiosError;
                                                                                                                        AxiosHeaders: typeof AxiosHeaders;
                                                                                                                        Cancel: CancelStatic;
                                                                                                                        CanceledError: typeof CanceledError;
                                                                                                                        CancelToken: CancelTokenStatic;
                                                                                                                        defaults: Omit<AxiosDefaults<any>, "headers"> & {
                                                                                                                            headers: HeadersDefaults & { [key: string]: AxiosHeaderValue };
                                                                                                                        };
                                                                                                                        formToJSON: (form: GenericFormData | GenericHTMLFormElement) => object;
                                                                                                                        getAdapter: (
                                                                                                                            adapters: undefined | AxiosAdapterConfig | AxiosAdapterConfig[],
                                                                                                                        ) => AxiosAdapter;
                                                                                                                        HttpStatusCode: typeof HttpStatusCode;
                                                                                                                        interceptors: {
                                                                                                                            request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>;
                                                                                                                            response: AxiosInterceptorManager<AxiosResponse<any, any>>;
                                                                                                                        };
                                                                                                                        isAxiosError: <T = any, D = any>(
                                                                                                                            payload: any,
                                                                                                                        ) => payload is AxiosError<T, D>;
                                                                                                                        isCancel: (value: any) => value is Cancel;
                                                                                                                        mergeConfig: <D = any>(
                                                                                                                            config1: AxiosRequestConfig<D>,
                                                                                                                            config2: AxiosRequestConfig<D>,
                                                                                                                        ) => AxiosRequestConfig<D>;
                                                                                                                        spread: <T, R>(callback: (...args: T[]) => R) => (array: T[]) => R;
                                                                                                                        toFormData: (
                                                                                                                            sourceObj: object,
                                                                                                                            targetFormData?: GenericFormData,
                                                                                                                            options?: FormSerializerOptions,
                                                                                                                        ) => GenericFormData;
                                                                                                                        VERSION: string;
                                                                                                                        create(config?: CreateAxiosDefaults<any>): AxiosInstance;
                                                                                                                        delete<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                            url: string,
                                                                                                                            config?: AxiosRequestConfig<D>,
                                                                                                                        ): Promise<R>;
                                                                                                                        get<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                            url: string,
                                                                                                                            config?: AxiosRequestConfig<D>,
                                                                                                                        ): Promise<R>;
                                                                                                                        getUri(config?: AxiosRequestConfig<any>): string;
                                                                                                                        head<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                            url: string,
                                                                                                                            config?: AxiosRequestConfig<D>,
                                                                                                                        ): Promise<R>;
                                                                                                                        options<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                            url: string,
                                                                                                                            config?: AxiosRequestConfig<D>,
                                                                                                                        ): Promise<R>;
                                                                                                                        patch<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                            url: string,
                                                                                                                            data?: D,
                                                                                                                            config?: AxiosRequestConfig<D>,
                                                                                                                        ): Promise<R>;
                                                                                                                        patchForm<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                            url: string,
                                                                                                                            data?: D,
                                                                                                                            config?: AxiosRequestConfig<D>,
                                                                                                                        ): Promise<R>;
                                                                                                                        post<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                            url: string,
                                                                                                                            data?: D,
                                                                                                                            config?: AxiosRequestConfig<D>,
                                                                                                                        ): Promise<R>;
                                                                                                                        postForm<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                            url: string,
                                                                                                                            data?: D,
                                                                                                                            config?: AxiosRequestConfig<D>,
                                                                                                                        ): Promise<R>;
                                                                                                                        put<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                            url: string,
                                                                                                                            data?: D,
                                                                                                                            config?: AxiosRequestConfig<D>,
                                                                                                                        ): Promise<R>;
                                                                                                                        putForm<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                            url: string,
                                                                                                                            data?: D,
                                                                                                                            config?: AxiosRequestConfig<D>,
                                                                                                                        ): Promise<R>;
                                                                                                                        request<T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                            config: AxiosRequestConfig<D>,
                                                                                                                        ): Promise<R>;
                                                                                                                        <T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                            config: AxiosRequestConfig<D>,
                                                                                                                        ): Promise<R>;
                                                                                                                        <T = any, R = AxiosResponse<T, any>, D = any>(
                                                                                                                            url: string,
                                                                                                                            config?: AxiosRequestConfig<D>,
                                                                                                                        ): Promise<R>;
                                                                                                                    }

                                                                                                                    Hierarchy (View Summary)

                                                                                                                    Index

                                                                                                                    Properties

                                                                                                                    all Axios AxiosError AxiosHeaders diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.BranchRow.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.BranchRow.html index e4a62b232..6b5373063 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.BranchRow.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.BranchRow.html @@ -1,4 +1,4 @@ -BranchRow | trilium
                                                                                                                    trilium
                                                                                                                      Preparing search index...

                                                                                                                      Interface BranchRow

                                                                                                                      interface BranchRow {
                                                                                                                          branchId?: string;
                                                                                                                          isDeleted?: boolean;
                                                                                                                          isExpanded?: boolean;
                                                                                                                          noteId: string;
                                                                                                                          notePosition?: null | number;
                                                                                                                          parentNoteId: string;
                                                                                                                          prefix?: null | string;
                                                                                                                          utcDateModified?: string;
                                                                                                                      }
                                                                                                                      Index

                                                                                                                      Properties

                                                                                                                      branchId? +BranchRow | trilium
                                                                                                                      trilium
                                                                                                                        Preparing search index...

                                                                                                                        Interface BranchRow

                                                                                                                        interface BranchRow {
                                                                                                                            branchId?: string;
                                                                                                                            isDeleted?: boolean;
                                                                                                                            isExpanded?: boolean;
                                                                                                                            noteId: string;
                                                                                                                            notePosition?: null | number;
                                                                                                                            parentNoteId: string;
                                                                                                                            prefix?: null | string;
                                                                                                                            utcDateModified?: string;
                                                                                                                        }
                                                                                                                        Index

                                                                                                                        Properties

                                                                                                                        branchId? isDeleted? isExpanded? noteId @@ -6,4 +6,4 @@ parentNoteId prefix? utcDateModified? -

                                                                                                                        Properties

                                                                                                                        branchId?: string
                                                                                                                        isDeleted?: boolean
                                                                                                                        isExpanded?: boolean
                                                                                                                        noteId: string
                                                                                                                        notePosition?: null | number
                                                                                                                        parentNoteId: string
                                                                                                                        prefix?: null | string
                                                                                                                        utcDateModified?: string

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        On This Page

                                                                                                                        Properties
                                                                                                                        +

                                                                                                                        Properties

                                                                                                                        branchId?: string
                                                                                                                        isDeleted?: boolean
                                                                                                                        isExpanded?: boolean
                                                                                                                        noteId: string
                                                                                                                        notePosition?: null | number
                                                                                                                        parentNoteId: string
                                                                                                                        prefix?: null | string
                                                                                                                        utcDateModified?: string

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        On This Page

                                                                                                                        Properties
                                                                                                                        diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.CheerioAPI.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.CheerioAPI.html index 06b5011f4..36749efa2 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.CheerioAPI.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.CheerioAPI.html @@ -1,4 +1,4 @@ -CheerioAPI | trilium
                                                                                                                        trilium
                                                                                                                          Preparing search index...

                                                                                                                          Interface CheerioAPI

                                                                                                                          interface CheerioAPI {
                                                                                                                              version: string;
                                                                                                                              contains(container: Element, contained: Element): boolean;
                                                                                                                              html(options?: CheerioParserOptions): string;
                                                                                                                              html(
                                                                                                                                  dom: string | Element | Cheerio,
                                                                                                                                  options?: CheerioParserOptions,
                                                                                                                              ): string;
                                                                                                                              load(
                                                                                                                                  html: string | Buffer<ArrayBufferLike>,
                                                                                                                                  options?: CheerioParserOptions,
                                                                                                                              ): Root;
                                                                                                                              load(element: Element | Element[], options?: CheerioParserOptions): Root;
                                                                                                                              parseHTML(
                                                                                                                                  data: string,
                                                                                                                                  context?: null | Document,
                                                                                                                                  keepScripts?: boolean,
                                                                                                                              ): Document[];
                                                                                                                              root(): Cheerio;
                                                                                                                              xml(dom?: string | Element | Cheerio): string;
                                                                                                                              (selector: string): Cheerio;
                                                                                                                              (selector: string, context: string): Cheerio;
                                                                                                                              (selector: string, context: Element): Cheerio;
                                                                                                                              (selector: string, context: Element[]): Cheerio;
                                                                                                                              (selector: string, context: Cheerio): Cheerio;
                                                                                                                              (selector: string, context: string, root: string): Cheerio;
                                                                                                                              (selector: string, context: Element, root: string): Cheerio;
                                                                                                                              (selector: string, context: Element[], root: string): Cheerio;
                                                                                                                              (selector: string, context: Cheerio, root: string): Cheerio;
                                                                                                                              (selector: any): Cheerio;
                                                                                                                          }

                                                                                                                          Hierarchy (View Summary)

                                                                                                                          • Parameters

                                                                                                                            • selector: string

                                                                                                                            Returns Cheerio

                                                                                                                          • Parameters

                                                                                                                            • selector: string
                                                                                                                            • context: string

                                                                                                                            Returns Cheerio

                                                                                                                          • Parameters

                                                                                                                            Returns Cheerio

                                                                                                                          • Parameters

                                                                                                                            Returns Cheerio

                                                                                                                          • Parameters

                                                                                                                            Returns Cheerio

                                                                                                                          • Parameters

                                                                                                                            • selector: string
                                                                                                                            • context: string
                                                                                                                            • root: string

                                                                                                                            Returns Cheerio

                                                                                                                          • Parameters

                                                                                                                            • selector: string
                                                                                                                            • context: Element
                                                                                                                            • root: string

                                                                                                                            Returns Cheerio

                                                                                                                          • Parameters

                                                                                                                            • selector: string
                                                                                                                            • context: Element[]
                                                                                                                            • root: string

                                                                                                                            Returns Cheerio

                                                                                                                          • Parameters

                                                                                                                            • selector: string
                                                                                                                            • context: Cheerio
                                                                                                                            • root: string

                                                                                                                            Returns Cheerio

                                                                                                                          • Parameters

                                                                                                                            • selector: any

                                                                                                                            Returns Cheerio

                                                                                                                          Index

                                                                                                                          Properties

                                                                                                                          version +CheerioAPI | trilium
                                                                                                                          trilium
                                                                                                                            Preparing search index...

                                                                                                                            Interface CheerioAPI

                                                                                                                            interface CheerioAPI {
                                                                                                                                version: string;
                                                                                                                                contains(container: Element, contained: Element): boolean;
                                                                                                                                html(options?: CheerioParserOptions): string;
                                                                                                                                html(
                                                                                                                                    dom: string | Element | Cheerio,
                                                                                                                                    options?: CheerioParserOptions,
                                                                                                                                ): string;
                                                                                                                                load(
                                                                                                                                    html: string | Buffer<ArrayBufferLike>,
                                                                                                                                    options?: CheerioParserOptions,
                                                                                                                                ): Root;
                                                                                                                                load(element: Element | Element[], options?: CheerioParserOptions): Root;
                                                                                                                                parseHTML(
                                                                                                                                    data: string,
                                                                                                                                    context?: null | Document,
                                                                                                                                    keepScripts?: boolean,
                                                                                                                                ): Document[];
                                                                                                                                root(): Cheerio;
                                                                                                                                xml(dom?: string | Element | Cheerio): string;
                                                                                                                                (selector: string): Cheerio;
                                                                                                                                (selector: string, context: string): Cheerio;
                                                                                                                                (selector: string, context: Element): Cheerio;
                                                                                                                                (selector: string, context: Element[]): Cheerio;
                                                                                                                                (selector: string, context: Cheerio): Cheerio;
                                                                                                                                (selector: string, context: string, root: string): Cheerio;
                                                                                                                                (selector: string, context: Element, root: string): Cheerio;
                                                                                                                                (selector: string, context: Element[], root: string): Cheerio;
                                                                                                                                (selector: string, context: Cheerio, root: string): Cheerio;
                                                                                                                                (selector: any): Cheerio;
                                                                                                                            }

                                                                                                                            Hierarchy (View Summary)

                                                                                                                            • Parameters

                                                                                                                              • selector: string

                                                                                                                              Returns Cheerio

                                                                                                                            • Parameters

                                                                                                                              • selector: string
                                                                                                                              • context: string

                                                                                                                              Returns Cheerio

                                                                                                                            • Parameters

                                                                                                                              Returns Cheerio

                                                                                                                            • Parameters

                                                                                                                              Returns Cheerio

                                                                                                                            • Parameters

                                                                                                                              Returns Cheerio

                                                                                                                            • Parameters

                                                                                                                              • selector: string
                                                                                                                              • context: string
                                                                                                                              • root: string

                                                                                                                              Returns Cheerio

                                                                                                                            • Parameters

                                                                                                                              • selector: string
                                                                                                                              • context: Element
                                                                                                                              • root: string

                                                                                                                              Returns Cheerio

                                                                                                                            • Parameters

                                                                                                                              • selector: string
                                                                                                                              • context: Element[]
                                                                                                                              • root: string

                                                                                                                              Returns Cheerio

                                                                                                                            • Parameters

                                                                                                                              • selector: string
                                                                                                                              • context: Cheerio
                                                                                                                              • root: string

                                                                                                                              Returns Cheerio

                                                                                                                            • Parameters

                                                                                                                              • selector: any

                                                                                                                              Returns Cheerio

                                                                                                                            Index

                                                                                                                            Properties

                                                                                                                            version

                                                                                                                            Methods

                                                                                                                            contains html load diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.CloneResponse.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.CloneResponse.html index 79ed62c56..9dbc2894a 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.CloneResponse.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.CloneResponse.html @@ -1,5 +1,5 @@ -CloneResponse | trilium
                                                                                                                            trilium
                                                                                                                              Preparing search index...

                                                                                                                              Interface CloneResponse

                                                                                                                              interface CloneResponse {
                                                                                                                                  branchId?: string;
                                                                                                                                  message?: string;
                                                                                                                                  notePath?: string;
                                                                                                                                  success: boolean;
                                                                                                                              }
                                                                                                                              Index

                                                                                                                              Properties

                                                                                                                              branchId? +CloneResponse | trilium
                                                                                                                              trilium
                                                                                                                                Preparing search index...

                                                                                                                                Interface CloneResponse

                                                                                                                                interface CloneResponse {
                                                                                                                                    branchId?: string;
                                                                                                                                    message?: string;
                                                                                                                                    notePath?: string;
                                                                                                                                    success: boolean;
                                                                                                                                }
                                                                                                                                Index

                                                                                                                                Properties

                                                                                                                                branchId? message? notePath? success -

                                                                                                                                Properties

                                                                                                                                branchId?: string
                                                                                                                                message?: string
                                                                                                                                notePath?: string
                                                                                                                                success: boolean

                                                                                                                                Settings

                                                                                                                                Member Visibility

                                                                                                                                On This Page

                                                                                                                                Properties
                                                                                                                                +

                                                                                                                                Properties

                                                                                                                                branchId?: string
                                                                                                                                message?: string
                                                                                                                                notePath?: string
                                                                                                                                success: boolean

                                                                                                                                Settings

                                                                                                                                Member Visibility

                                                                                                                                On This Page

                                                                                                                                Properties
                                                                                                                                diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-1.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-1.html index 1c4e7a617..6de532854 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-1.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-1.html @@ -1,3 +1,3 @@ -ContentOpts | trilium
                                                                                                                                trilium
                                                                                                                                  Preparing search index...

                                                                                                                                  Interface ContentOpts

                                                                                                                                  interface ContentOpts {
                                                                                                                                      forceFrontendReload?: boolean;
                                                                                                                                      forceSave?: boolean;
                                                                                                                                  }
                                                                                                                                  Index

                                                                                                                                  Properties

                                                                                                                                  forceFrontendReload? +ContentOpts | trilium
                                                                                                                                  trilium
                                                                                                                                    Preparing search index...

                                                                                                                                    Interface ContentOpts

                                                                                                                                    interface ContentOpts {
                                                                                                                                        forceFrontendReload?: boolean;
                                                                                                                                        forceSave?: boolean;
                                                                                                                                    }
                                                                                                                                    Index

                                                                                                                                    Properties

                                                                                                                                    forceFrontendReload? forceSave? -

                                                                                                                                    Properties

                                                                                                                                    forceFrontendReload?: boolean
                                                                                                                                    forceSave?: boolean

                                                                                                                                    Settings

                                                                                                                                    Member Visibility

                                                                                                                                    On This Page

                                                                                                                                    Properties
                                                                                                                                    +

                                                                                                                                    Properties

                                                                                                                                    forceFrontendReload?: boolean
                                                                                                                                    forceSave?: boolean

                                                                                                                                    Settings

                                                                                                                                    Member Visibility

                                                                                                                                    On This Page

                                                                                                                                    Properties
                                                                                                                                    diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-2.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-2.html index 5697b8c2d..aa063a8b7 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-2.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-2.html @@ -1,6 +1,6 @@ -ContentOpts | trilium
                                                                                                                                    trilium
                                                                                                                                      Preparing search index...

                                                                                                                                      Interface ContentOpts

                                                                                                                                      interface ContentOpts {
                                                                                                                                          forceFrontendReload?: boolean;
                                                                                                                                          forceFullSave?: boolean;
                                                                                                                                          forceSave?: boolean;
                                                                                                                                      }
                                                                                                                                      Index

                                                                                                                                      Properties

                                                                                                                                      forceFrontendReload? +ContentOpts | trilium
                                                                                                                                      trilium
                                                                                                                                        Preparing search index...

                                                                                                                                        Interface ContentOpts

                                                                                                                                        interface ContentOpts {
                                                                                                                                            forceFrontendReload?: boolean;
                                                                                                                                            forceFullSave?: boolean;
                                                                                                                                            forceSave?: boolean;
                                                                                                                                        }
                                                                                                                                        Index

                                                                                                                                        Properties

                                                                                                                                        forceFrontendReload? forceFullSave? forceSave?

                                                                                                                                        Properties

                                                                                                                                        forceFrontendReload?: boolean

                                                                                                                                        override frontend heuristics on when to reload, instruct to reload

                                                                                                                                        -
                                                                                                                                        forceFullSave?: boolean

                                                                                                                                        will also save this BAttachment entity

                                                                                                                                        -
                                                                                                                                        forceSave?: boolean

                                                                                                                                        Settings

                                                                                                                                        Member Visibility

                                                                                                                                        On This Page

                                                                                                                                        Properties
                                                                                                                                        +
                                                                                                                                        forceFullSave?: boolean

                                                                                                                                        will also save this BAttachment entity

                                                                                                                                        +
                                                                                                                                        forceSave?: boolean

                                                                                                                                        Settings

                                                                                                                                        Member Visibility

                                                                                                                                        On This Page

                                                                                                                                        Properties
                                                                                                                                        diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-3.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-3.html index f9fc7007a..1c3e3a6a4 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-3.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts-3.html @@ -1,3 +1,3 @@ -ContentOpts | trilium
                                                                                                                                        trilium
                                                                                                                                          Preparing search index...

                                                                                                                                          Interface ContentOpts

                                                                                                                                          interface ContentOpts {
                                                                                                                                              forceSave?: boolean;
                                                                                                                                          }
                                                                                                                                          Index

                                                                                                                                          Properties

                                                                                                                                          forceSave? +ContentOpts | trilium
                                                                                                                                          trilium
                                                                                                                                            Preparing search index...

                                                                                                                                            Interface ContentOpts

                                                                                                                                            interface ContentOpts {
                                                                                                                                                forceSave?: boolean;
                                                                                                                                            }
                                                                                                                                            Index

                                                                                                                                            Properties

                                                                                                                                            forceSave?

                                                                                                                                            Properties

                                                                                                                                            forceSave?: boolean

                                                                                                                                            will also save this BRevision entity

                                                                                                                                            -

                                                                                                                                            Settings

                                                                                                                                            Member Visibility

                                                                                                                                            On This Page

                                                                                                                                            Properties
                                                                                                                                            +

                                                                                                                                            Settings

                                                                                                                                            Member Visibility

                                                                                                                                            On This Page

                                                                                                                                            Properties
                                                                                                                                            diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts.html index 6462bfe4a..d1d657adb 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.ContentOpts.html @@ -1,5 +1,5 @@ -ContentOpts | trilium
                                                                                                                                            trilium
                                                                                                                                              Preparing search index...

                                                                                                                                              Interface ContentOpts

                                                                                                                                              interface ContentOpts {
                                                                                                                                                  forceFrontendReload?: boolean;
                                                                                                                                                  forceSave?: boolean;
                                                                                                                                              }
                                                                                                                                              Index

                                                                                                                                              Properties

                                                                                                                                              forceFrontendReload? +ContentOpts | trilium
                                                                                                                                              trilium
                                                                                                                                                Preparing search index...

                                                                                                                                                Interface ContentOpts

                                                                                                                                                interface ContentOpts {
                                                                                                                                                    forceFrontendReload?: boolean;
                                                                                                                                                    forceSave?: boolean;
                                                                                                                                                }
                                                                                                                                                Index

                                                                                                                                                Properties

                                                                                                                                                forceFrontendReload? forceSave?

                                                                                                                                                Properties

                                                                                                                                                forceFrontendReload?: boolean

                                                                                                                                                override frontend heuristics on when to reload, instruct to reload

                                                                                                                                                -
                                                                                                                                                forceSave?: boolean

                                                                                                                                                will also save this BNote entity

                                                                                                                                                -

                                                                                                                                                Settings

                                                                                                                                                Member Visibility

                                                                                                                                                On This Page

                                                                                                                                                Properties
                                                                                                                                                +
                                                                                                                                                forceSave?: boolean

                                                                                                                                                will also save this BNote entity

                                                                                                                                                +

                                                                                                                                                Settings

                                                                                                                                                Member Visibility

                                                                                                                                                On This Page

                                                                                                                                                Properties
                                                                                                                                                diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.ConvertOpts.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.ConvertOpts.html index ff7947fb7..8a3d30fb1 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.ConvertOpts.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.ConvertOpts.html @@ -1,3 +1,3 @@ -ConvertOpts | trilium
                                                                                                                                                trilium
                                                                                                                                                  Preparing search index...

                                                                                                                                                  Interface ConvertOpts

                                                                                                                                                  interface ConvertOpts {
                                                                                                                                                      autoConversion?: boolean;
                                                                                                                                                  }
                                                                                                                                                  Index

                                                                                                                                                  Properties

                                                                                                                                                  autoConversion? +ConvertOpts | trilium
                                                                                                                                                  trilium
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Interface ConvertOpts

                                                                                                                                                    interface ConvertOpts {
                                                                                                                                                        autoConversion?: boolean;
                                                                                                                                                    }
                                                                                                                                                    Index

                                                                                                                                                    Properties

                                                                                                                                                    autoConversion?

                                                                                                                                                    Properties

                                                                                                                                                    autoConversion?: boolean

                                                                                                                                                    if true, the action is not triggered by user, but e.g. by migration, and only perfect candidates will be migrated

                                                                                                                                                    -

                                                                                                                                                    Settings

                                                                                                                                                    Member Visibility

                                                                                                                                                    On This Page

                                                                                                                                                    Properties
                                                                                                                                                    +

                                                                                                                                                    Settings

                                                                                                                                                    Member Visibility

                                                                                                                                                    On This Page

                                                                                                                                                    Properties
                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.CreateAxiosDefaults.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.CreateAxiosDefaults.html index e38dc8f8f..f07691a53 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.CreateAxiosDefaults.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.CreateAxiosDefaults.html @@ -1,5 +1,5 @@ CreateAxiosDefaults | trilium
                                                                                                                                                    trilium
                                                                                                                                                      Preparing search index...

                                                                                                                                                      Interface CreateAxiosDefaults<D>

                                                                                                                                                      Construct a type with the properties of T except for those in type K.

                                                                                                                                                      -
                                                                                                                                                      interface CreateAxiosDefaults<D = any> {
                                                                                                                                                          adapter?: AxiosAdapterConfig | AxiosAdapterConfig[];
                                                                                                                                                          allowAbsoluteUrls?: boolean;
                                                                                                                                                          auth?: AxiosBasicCredentials;
                                                                                                                                                          baseURL?: string;
                                                                                                                                                          beforeRedirect?: (
                                                                                                                                                              options: Record<string, any>,
                                                                                                                                                              responseDetails: {
                                                                                                                                                                  headers: Record<string, string>;
                                                                                                                                                                  statusCode: HttpStatusCode;
                                                                                                                                                              },
                                                                                                                                                          ) => void;
                                                                                                                                                          cancelToken?: CancelToken;
                                                                                                                                                          data?: D;
                                                                                                                                                          decompress?: boolean;
                                                                                                                                                          env?: { FormData?: new (...args: any[]) => object };
                                                                                                                                                          family?: AddressFamily;
                                                                                                                                                          fetchOptions?: Record<string, any>;
                                                                                                                                                          formSerializer?: FormSerializerOptions;
                                                                                                                                                          headers?:
                                                                                                                                                              | AxiosHeaders
                                                                                                                                                              | Partial<HeadersDefaults>
                                                                                                                                                              | Partial<
                                                                                                                                                                  RawAxiosHeaders & {
                                                                                                                                                                      Accept: AxiosHeaderValue;
                                                                                                                                                                      Authorization: AxiosHeaderValue;
                                                                                                                                                                      "Content-Encoding": AxiosHeaderValue;
                                                                                                                                                                      "Content-Length": AxiosHeaderValue;
                                                                                                                                                                      "User-Agent": AxiosHeaderValue;
                                                                                                                                                                  } & { "Content-Type": ContentType },
                                                                                                                                                              >;
                                                                                                                                                          httpAgent?: any;
                                                                                                                                                          httpsAgent?: any;
                                                                                                                                                          insecureHTTPParser?: boolean;
                                                                                                                                                          lookup?:
                                                                                                                                                              | (
                                                                                                                                                                  (
                                                                                                                                                                      hostname: string,
                                                                                                                                                                      options: object,
                                                                                                                                                                      cb: (
                                                                                                                                                                          err: null | Error,
                                                                                                                                                                          address: LookupAddress | LookupAddress[],
                                                                                                                                                                          family?: AddressFamily,
                                                                                                                                                                      ) => void,
                                                                                                                                                                  ) => void
                                                                                                                                                              )
                                                                                                                                                              | (
                                                                                                                                                                  (
                                                                                                                                                                      hostname: string,
                                                                                                                                                                      options: object,
                                                                                                                                                                  ) => Promise<
                                                                                                                                                                      | LookupAddress
                                                                                                                                                                      | [
                                                                                                                                                                          address: LookupAddressEntry
                                                                                                                                                                          | LookupAddressEntry[],
                                                                                                                                                                          family?: AddressFamily,
                                                                                                                                                                      ],
                                                                                                                                                                  >
                                                                                                                                                              );
                                                                                                                                                          maxBodyLength?: number;
                                                                                                                                                          maxContentLength?: number;
                                                                                                                                                          maxRate?: number | [number, number];
                                                                                                                                                          maxRedirects?: number;
                                                                                                                                                          method?: string;
                                                                                                                                                          onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                                                                          onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                                                                          params?: any;
                                                                                                                                                          paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer;
                                                                                                                                                          proxy?: false | AxiosProxyConfig;
                                                                                                                                                          responseEncoding?: string;
                                                                                                                                                          responseType?: ResponseType;
                                                                                                                                                          signal?: GenericAbortSignal;
                                                                                                                                                          socketPath?: null | string;
                                                                                                                                                          timeout?: number;
                                                                                                                                                          timeoutErrorMessage?: string;
                                                                                                                                                          transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
                                                                                                                                                          transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
                                                                                                                                                          transitional?: TransitionalOptions;
                                                                                                                                                          transport?: any;
                                                                                                                                                          url?: string;
                                                                                                                                                          validateStatus?: null | ((status: number) => boolean);
                                                                                                                                                          withCredentials?: boolean;
                                                                                                                                                          withXSRFToken?:
                                                                                                                                                              | boolean
                                                                                                                                                              | ((config: InternalAxiosRequestConfig) => undefined | boolean);
                                                                                                                                                          xsrfCookieName?: string;
                                                                                                                                                          xsrfHeaderName?: string;
                                                                                                                                                      }

                                                                                                                                                      Type Parameters

                                                                                                                                                      • D = any

                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                      Index

                                                                                                                                                      Properties

                                                                                                                                                      adapter? +
                                                                                                                                                      interface CreateAxiosDefaults<D = any> {
                                                                                                                                                          adapter?: AxiosAdapterConfig | AxiosAdapterConfig[];
                                                                                                                                                          allowAbsoluteUrls?: boolean;
                                                                                                                                                          auth?: AxiosBasicCredentials;
                                                                                                                                                          baseURL?: string;
                                                                                                                                                          beforeRedirect?: (
                                                                                                                                                              options: Record<string, any>,
                                                                                                                                                              responseDetails: {
                                                                                                                                                                  headers: Record<string, string>;
                                                                                                                                                                  statusCode: HttpStatusCode;
                                                                                                                                                              },
                                                                                                                                                          ) => void;
                                                                                                                                                          cancelToken?: CancelToken;
                                                                                                                                                          data?: D;
                                                                                                                                                          decompress?: boolean;
                                                                                                                                                          env?: { FormData?: new (...args: any[]) => object };
                                                                                                                                                          family?: AddressFamily;
                                                                                                                                                          fetchOptions?: Record<string, any>;
                                                                                                                                                          formSerializer?: FormSerializerOptions;
                                                                                                                                                          headers?:
                                                                                                                                                              | AxiosHeaders
                                                                                                                                                              | Partial<HeadersDefaults>
                                                                                                                                                              | Partial<
                                                                                                                                                                  RawAxiosHeaders & {
                                                                                                                                                                      Accept: AxiosHeaderValue;
                                                                                                                                                                      Authorization: AxiosHeaderValue;
                                                                                                                                                                      "Content-Encoding": AxiosHeaderValue;
                                                                                                                                                                      "Content-Length": AxiosHeaderValue;
                                                                                                                                                                      "User-Agent": AxiosHeaderValue;
                                                                                                                                                                  } & { "Content-Type": ContentType },
                                                                                                                                                              >;
                                                                                                                                                          httpAgent?: any;
                                                                                                                                                          httpsAgent?: any;
                                                                                                                                                          insecureHTTPParser?: boolean;
                                                                                                                                                          lookup?:
                                                                                                                                                              | (
                                                                                                                                                                  (
                                                                                                                                                                      hostname: string,
                                                                                                                                                                      options: object,
                                                                                                                                                                      cb: (
                                                                                                                                                                          err: null | Error,
                                                                                                                                                                          address: LookupAddress | LookupAddress[],
                                                                                                                                                                          family?: AddressFamily,
                                                                                                                                                                      ) => void,
                                                                                                                                                                  ) => void
                                                                                                                                                              )
                                                                                                                                                              | (
                                                                                                                                                                  (
                                                                                                                                                                      hostname: string,
                                                                                                                                                                      options: object,
                                                                                                                                                                  ) => Promise<
                                                                                                                                                                      | LookupAddress
                                                                                                                                                                      | [
                                                                                                                                                                          address: LookupAddressEntry
                                                                                                                                                                          | LookupAddressEntry[],
                                                                                                                                                                          family?: AddressFamily,
                                                                                                                                                                      ],
                                                                                                                                                                  >
                                                                                                                                                              );
                                                                                                                                                          maxBodyLength?: number;
                                                                                                                                                          maxContentLength?: number;
                                                                                                                                                          maxRate?: number | [number, number];
                                                                                                                                                          maxRedirects?: number;
                                                                                                                                                          method?: string;
                                                                                                                                                          onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                                                                          onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                                                                          params?: any;
                                                                                                                                                          paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer;
                                                                                                                                                          proxy?: false | AxiosProxyConfig;
                                                                                                                                                          responseEncoding?: string;
                                                                                                                                                          responseType?: ResponseType;
                                                                                                                                                          signal?: GenericAbortSignal;
                                                                                                                                                          socketPath?: null | string;
                                                                                                                                                          timeout?: number;
                                                                                                                                                          timeoutErrorMessage?: string;
                                                                                                                                                          transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
                                                                                                                                                          transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
                                                                                                                                                          transitional?: TransitionalOptions;
                                                                                                                                                          transport?: any;
                                                                                                                                                          url?: string;
                                                                                                                                                          validateStatus?: null | ((status: number) => boolean);
                                                                                                                                                          withCredentials?: boolean;
                                                                                                                                                          withXSRFToken?:
                                                                                                                                                              | boolean
                                                                                                                                                              | ((config: InternalAxiosRequestConfig) => undefined | boolean);
                                                                                                                                                          xsrfCookieName?: string;
                                                                                                                                                          xsrfHeaderName?: string;
                                                                                                                                                      }

                                                                                                                                                      Type Parameters

                                                                                                                                                      • D = any

                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                      Index

                                                                                                                                                      Properties

                                                                                                                                                      adapter? allowAbsoluteUrls? auth? baseURL? diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.DefinitionObject.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.DefinitionObject.html index 350dbb5b4..3e9c63c1e 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.DefinitionObject.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.DefinitionObject.html @@ -1,7 +1,7 @@ -DefinitionObject | trilium
                                                                                                                                                      trilium
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Interface DefinitionObject

                                                                                                                                                        interface DefinitionObject {
                                                                                                                                                            inverseRelation?: string;
                                                                                                                                                            isPromoted?: boolean;
                                                                                                                                                            labelType?: string;
                                                                                                                                                            multiplicity?: string;
                                                                                                                                                            numberPrecision?: number;
                                                                                                                                                            promotedAlias?: string;
                                                                                                                                                        }
                                                                                                                                                        Index

                                                                                                                                                        Properties

                                                                                                                                                        inverseRelation? +DefinitionObject | trilium
                                                                                                                                                        trilium
                                                                                                                                                          Preparing search index...

                                                                                                                                                          Interface DefinitionObject

                                                                                                                                                          interface DefinitionObject {
                                                                                                                                                              inverseRelation?: string;
                                                                                                                                                              isPromoted?: boolean;
                                                                                                                                                              labelType?: string;
                                                                                                                                                              multiplicity?: string;
                                                                                                                                                              numberPrecision?: number;
                                                                                                                                                              promotedAlias?: string;
                                                                                                                                                          }
                                                                                                                                                          Index

                                                                                                                                                          Properties

                                                                                                                                                          inverseRelation? isPromoted? labelType? multiplicity? numberPrecision? promotedAlias? -

                                                                                                                                                          Properties

                                                                                                                                                          inverseRelation?: string
                                                                                                                                                          isPromoted?: boolean
                                                                                                                                                          labelType?: string
                                                                                                                                                          multiplicity?: string
                                                                                                                                                          numberPrecision?: number
                                                                                                                                                          promotedAlias?: string

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility

                                                                                                                                                          On This Page

                                                                                                                                                          Properties
                                                                                                                                                          +

                                                                                                                                                          Properties

                                                                                                                                                          inverseRelation?: string
                                                                                                                                                          isPromoted?: boolean
                                                                                                                                                          labelType?: string
                                                                                                                                                          multiplicity?: string
                                                                                                                                                          numberPrecision?: number
                                                                                                                                                          promotedAlias?: string

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility

                                                                                                                                                          On This Page

                                                                                                                                                          Properties
                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.EtapiTokenRow.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.EtapiTokenRow.html index 63ce896a2..ad6cdf6a2 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.EtapiTokenRow.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.EtapiTokenRow.html @@ -1,7 +1,7 @@ -EtapiTokenRow | trilium
                                                                                                                                                          trilium
                                                                                                                                                            Preparing search index...

                                                                                                                                                            Interface EtapiTokenRow

                                                                                                                                                            interface EtapiTokenRow {
                                                                                                                                                                etapiTokenId?: string;
                                                                                                                                                                isDeleted?: boolean;
                                                                                                                                                                name: string;
                                                                                                                                                                tokenHash: string;
                                                                                                                                                                utcDateCreated?: string;
                                                                                                                                                                utcDateModified?: string;
                                                                                                                                                            }
                                                                                                                                                            Index

                                                                                                                                                            Properties

                                                                                                                                                            etapiTokenId? +EtapiTokenRow | trilium
                                                                                                                                                            trilium
                                                                                                                                                              Preparing search index...

                                                                                                                                                              Interface EtapiTokenRow

                                                                                                                                                              interface EtapiTokenRow {
                                                                                                                                                                  etapiTokenId?: string;
                                                                                                                                                                  isDeleted?: boolean;
                                                                                                                                                                  name: string;
                                                                                                                                                                  tokenHash: string;
                                                                                                                                                                  utcDateCreated?: string;
                                                                                                                                                                  utcDateModified?: string;
                                                                                                                                                              }
                                                                                                                                                              Index

                                                                                                                                                              Properties

                                                                                                                                                              etapiTokenId? isDeleted? name tokenHash utcDateCreated? utcDateModified? -

                                                                                                                                                              Properties

                                                                                                                                                              etapiTokenId?: string
                                                                                                                                                              isDeleted?: boolean
                                                                                                                                                              name: string
                                                                                                                                                              tokenHash: string
                                                                                                                                                              utcDateCreated?: string
                                                                                                                                                              utcDateModified?: string

                                                                                                                                                              Settings

                                                                                                                                                              Member Visibility

                                                                                                                                                              On This Page

                                                                                                                                                              Properties
                                                                                                                                                              +

                                                                                                                                                              Properties

                                                                                                                                                              etapiTokenId?: string
                                                                                                                                                              isDeleted?: boolean
                                                                                                                                                              name: string
                                                                                                                                                              tokenHash: string
                                                                                                                                                              utcDateCreated?: string
                                                                                                                                                              utcDateModified?: string

                                                                                                                                                              Settings

                                                                                                                                                              Member Visibility

                                                                                                                                                              On This Page

                                                                                                                                                              Properties
                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResourceOptions.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResourceOptions.html index e8e7c0dd8..8cb48ddbe 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResourceOptions.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterAsyncResourceOptions.html @@ -1,4 +1,4 @@ -EventEmitterAsyncResourceOptions | trilium
                                                                                                                                                              trilium
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Interface EventEmitterAsyncResourceOptions

                                                                                                                                                                interface EventEmitterAsyncResourceOptions {
                                                                                                                                                                    captureRejections?: boolean;
                                                                                                                                                                    name?: string;
                                                                                                                                                                    requireManualDestroy?: boolean;
                                                                                                                                                                    triggerAsyncId?: number;
                                                                                                                                                                }

                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                Index

                                                                                                                                                                Properties

                                                                                                                                                                captureRejections? +EventEmitterAsyncResourceOptions | trilium
                                                                                                                                                                trilium
                                                                                                                                                                  Preparing search index...

                                                                                                                                                                  Interface EventEmitterAsyncResourceOptions

                                                                                                                                                                  interface EventEmitterAsyncResourceOptions {
                                                                                                                                                                      captureRejections?: boolean;
                                                                                                                                                                      name?: string;
                                                                                                                                                                      requireManualDestroy?: boolean;
                                                                                                                                                                      triggerAsyncId?: number;
                                                                                                                                                                  }

                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                  Index

                                                                                                                                                                  Properties

                                                                                                                                                                  captureRejections? name? requireManualDestroy? triggerAsyncId? diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterReferencingAsyncResource.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterReferencingAsyncResource.html index bce2782f4..a49a83e9d 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterReferencingAsyncResource.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.EventEmitterReferencingAsyncResource.html @@ -6,7 +6,7 @@ own resources.

                                                                                                                                                                  import { AsyncResource, executionAsyncId } from 'node:async_hooks';

                                                                                                                                                                  // AsyncResource() is meant to be extended. Instantiating a
                                                                                                                                                                  // new AsyncResource() also triggers init. If triggerAsyncId is omitted then
                                                                                                                                                                  // async_hook.executionAsyncId() is used.
                                                                                                                                                                  const asyncResource = new AsyncResource(
                                                                                                                                                                    type, { triggerAsyncId: executionAsyncId(), requireManualDestroy: false },
                                                                                                                                                                  );

                                                                                                                                                                  // Run a function in the execution context of the resource. This will
                                                                                                                                                                  // * establish the context of the resource
                                                                                                                                                                  // * trigger the AsyncHooks before callbacks
                                                                                                                                                                  // * call the provided function `fn` with the supplied arguments
                                                                                                                                                                  // * trigger the AsyncHooks after callbacks
                                                                                                                                                                  // * restore the original execution context
                                                                                                                                                                  asyncResource.runInAsyncScope(fn, thisArg, ...args);

                                                                                                                                                                  // Call AsyncHooks destroy callbacks.
                                                                                                                                                                  asyncResource.emitDestroy();

                                                                                                                                                                  // Return the unique ID assigned to the AsyncResource instance.
                                                                                                                                                                  asyncResource.asyncId();

                                                                                                                                                                  // Return the trigger ID for the AsyncResource instance.
                                                                                                                                                                  asyncResource.triggerAsyncId();
                                                                                                                                                                  -
                                                                                                                                                                  interface EventEmitterReferencingAsyncResource {
                                                                                                                                                                      eventEmitter: EventEmitterAsyncResource;
                                                                                                                                                                      asyncId(): number;
                                                                                                                                                                      bind<Func extends (...args: any[]) => any>(fn: Func): Func;
                                                                                                                                                                      emitDestroy(): this;
                                                                                                                                                                      runInAsyncScope<This, Result>(
                                                                                                                                                                          fn: (this: This, ...args: any[]) => Result,
                                                                                                                                                                          thisArg?: This,
                                                                                                                                                                          ...args: any[],
                                                                                                                                                                      ): Result;
                                                                                                                                                                      triggerAsyncId(): number;
                                                                                                                                                                  }

                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                  Index

                                                                                                                                                                  Properties

                                                                                                                                                                  eventEmitter +
                                                                                                                                                                  interface EventEmitterReferencingAsyncResource {
                                                                                                                                                                      eventEmitter: EventEmitterAsyncResource;
                                                                                                                                                                      asyncId(): number;
                                                                                                                                                                      bind<Func extends (...args: any[]) => any>(fn: Func): Func;
                                                                                                                                                                      emitDestroy(): this;
                                                                                                                                                                      runInAsyncScope<This, Result>(
                                                                                                                                                                          fn: (this: This, ...args: any[]) => Result,
                                                                                                                                                                          thisArg?: This,
                                                                                                                                                                          ...args: any[],
                                                                                                                                                                      ): Result;
                                                                                                                                                                      triggerAsyncId(): number;
                                                                                                                                                                  }

                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                  Index

                                                                                                                                                                  Properties

                                                                                                                                                                  eventEmitter

                                                                                                                                                                  Methods

                                                                                                                                                                  asyncId bind emitDestroy diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.html index 7e59fe026..71eb56042 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitter.html @@ -1,4 +1,4 @@ -EventEmitter | trilium
                                                                                                                                                                  trilium
                                                                                                                                                                    Preparing search index...

                                                                                                                                                                    Interface EventEmitter<T>

                                                                                                                                                                    interface EventEmitter<T extends EventMap<T> = DefaultEventMap> {
                                                                                                                                                                        "[captureRejectionSymbol]"<K>(
                                                                                                                                                                            error: Error,
                                                                                                                                                                            event: Key<K, T>,
                                                                                                                                                                            ...args: Args<K, T>,
                                                                                                                                                                        ): void;
                                                                                                                                                                        addListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                        emit<K>(eventName: Key<K, T>, ...args: Args<K, T>): boolean;
                                                                                                                                                                        eventNames(): ((string | symbol) & Key2<unknown, T>)[];
                                                                                                                                                                        getMaxListeners(): number;
                                                                                                                                                                        listenerCount<K>(
                                                                                                                                                                            eventName: Key<K, T>,
                                                                                                                                                                            listener?: Listener<K, T, Function>,
                                                                                                                                                                        ): number;
                                                                                                                                                                        listeners<K>(eventName: Key<K, T>): Listener<K, T, Function>[];
                                                                                                                                                                        off<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                        on<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                        once<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                        prependListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                        prependOnceListener<K>(
                                                                                                                                                                            eventName: Key<K, T>,
                                                                                                                                                                            listener: Listener<K, T>,
                                                                                                                                                                        ): this;
                                                                                                                                                                        rawListeners<K>(eventName: Key<K, T>): Listener<K, T, Function>[];
                                                                                                                                                                        removeAllListeners(eventName?: Key<unknown, T>): this;
                                                                                                                                                                        removeListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                        setMaxListeners(n: number): this;
                                                                                                                                                                    }

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                    Index

                                                                                                                                                                    Methods

                                                                                                                                                                    [captureRejectionSymbol]? +EventEmitter | trilium
                                                                                                                                                                    trilium
                                                                                                                                                                      Preparing search index...

                                                                                                                                                                      Interface EventEmitter<T>

                                                                                                                                                                      interface EventEmitter<T extends EventMap<T> = DefaultEventMap> {
                                                                                                                                                                          "[captureRejectionSymbol]"<K>(
                                                                                                                                                                              error: Error,
                                                                                                                                                                              event: Key<K, T>,
                                                                                                                                                                              ...args: Args<K, T>,
                                                                                                                                                                          ): void;
                                                                                                                                                                          addListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                          emit<K>(eventName: Key<K, T>, ...args: Args<K, T>): boolean;
                                                                                                                                                                          eventNames(): ((string | symbol) & Key2<unknown, T>)[];
                                                                                                                                                                          getMaxListeners(): number;
                                                                                                                                                                          listenerCount<K>(
                                                                                                                                                                              eventName: Key<K, T>,
                                                                                                                                                                              listener?: Listener<K, T, Function>,
                                                                                                                                                                          ): number;
                                                                                                                                                                          listeners<K>(eventName: Key<K, T>): Listener<K, T, Function>[];
                                                                                                                                                                          off<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                          on<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                          once<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                          prependListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                          prependOnceListener<K>(
                                                                                                                                                                              eventName: Key<K, T>,
                                                                                                                                                                              listener: Listener<K, T>,
                                                                                                                                                                          ): this;
                                                                                                                                                                          rawListeners<K>(eventName: Key<K, T>): Listener<K, T, Function>[];
                                                                                                                                                                          removeAllListeners(eventName?: Key<unknown, T>): this;
                                                                                                                                                                          removeListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                          setMaxListeners(n: number): this;
                                                                                                                                                                      }

                                                                                                                                                                      Type Parameters

                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                      Index

                                                                                                                                                                      Methods

                                                                                                                                                                      [captureRejectionSymbol]? addListener emit eventNames diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitterOptions.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitterOptions.html index cadfeb0da..d4e6d9d8b 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitterOptions.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.EventEmitterOptions.html @@ -1,3 +1,3 @@ -EventEmitterOptions | trilium
                                                                                                                                                                      trilium
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Interface EventEmitterOptions

                                                                                                                                                                        interface EventEmitterOptions {
                                                                                                                                                                            captureRejections?: boolean;
                                                                                                                                                                        }

                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                        Index

                                                                                                                                                                        Properties

                                                                                                                                                                        captureRejections? +EventEmitterOptions | trilium
                                                                                                                                                                        trilium
                                                                                                                                                                          Preparing search index...

                                                                                                                                                                          Interface EventEmitterOptions

                                                                                                                                                                          interface EventEmitterOptions {
                                                                                                                                                                              captureRejections?: boolean;
                                                                                                                                                                          }

                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                          Index

                                                                                                                                                                          Properties

                                                                                                                                                                          captureRejections?

                                                                                                                                                                          Properties

                                                                                                                                                                          captureRejections?: boolean

                                                                                                                                                                          Enables automatic capturing of promise rejection.

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          On This Page

                                                                                                                                                                          Properties
                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.FormSerializerOptions.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.FormSerializerOptions.html index 3b65811b4..aace4e92c 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.FormSerializerOptions.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.FormSerializerOptions.html @@ -1,4 +1,4 @@ -FormSerializerOptions | trilium
                                                                                                                                                                          trilium
                                                                                                                                                                            Preparing search index...

                                                                                                                                                                            Interface FormSerializerOptions

                                                                                                                                                                            interface FormSerializerOptions {
                                                                                                                                                                                dots?: boolean;
                                                                                                                                                                                indexes?: null | boolean;
                                                                                                                                                                                metaTokens?: boolean;
                                                                                                                                                                                visitor?: SerializerVisitor;
                                                                                                                                                                            }

                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                            Index

                                                                                                                                                                            Properties

                                                                                                                                                                            dots? +FormSerializerOptions | trilium
                                                                                                                                                                            trilium
                                                                                                                                                                              Preparing search index...

                                                                                                                                                                              Interface FormSerializerOptions

                                                                                                                                                                              interface FormSerializerOptions {
                                                                                                                                                                                  dots?: boolean;
                                                                                                                                                                                  indexes?: null | boolean;
                                                                                                                                                                                  metaTokens?: boolean;
                                                                                                                                                                                  visitor?: SerializerVisitor;
                                                                                                                                                                              }

                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                              Index

                                                                                                                                                                              Properties

                                                                                                                                                                              dots? indexes? metaTokens? visitor? diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.GetByIdOpts.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.GetByIdOpts.html index 9bcf57d81..5bfeb853f 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.GetByIdOpts.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.GetByIdOpts.html @@ -1,2 +1,2 @@ -GetByIdOpts | trilium
                                                                                                                                                                              trilium
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Interface GetByIdOpts

                                                                                                                                                                                interface GetByIdOpts {
                                                                                                                                                                                    includeContentLength?: boolean;
                                                                                                                                                                                }
                                                                                                                                                                                Index

                                                                                                                                                                                Properties

                                                                                                                                                                                includeContentLength? -

                                                                                                                                                                                Properties

                                                                                                                                                                                includeContentLength?: boolean

                                                                                                                                                                                Settings

                                                                                                                                                                                Member Visibility

                                                                                                                                                                                On This Page

                                                                                                                                                                                Properties
                                                                                                                                                                                +GetByIdOpts | trilium
                                                                                                                                                                                trilium
                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                  Interface GetByIdOpts

                                                                                                                                                                                  interface GetByIdOpts {
                                                                                                                                                                                      includeContentLength?: boolean;
                                                                                                                                                                                  }
                                                                                                                                                                                  Index

                                                                                                                                                                                  Properties

                                                                                                                                                                                  includeContentLength? +

                                                                                                                                                                                  Properties

                                                                                                                                                                                  includeContentLength?: boolean

                                                                                                                                                                                  Settings

                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                  On This Page

                                                                                                                                                                                  Properties
                                                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.InternalAxiosRequestConfig.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.InternalAxiosRequestConfig.html index 33a5274d2..1a3fb2226 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.InternalAxiosRequestConfig.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.InternalAxiosRequestConfig.html @@ -1,4 +1,4 @@ -InternalAxiosRequestConfig | trilium
                                                                                                                                                                                  trilium
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Interface InternalAxiosRequestConfig<D>

                                                                                                                                                                                    interface InternalAxiosRequestConfig<D = any> {
                                                                                                                                                                                        adapter?: AxiosAdapterConfig | AxiosAdapterConfig[];
                                                                                                                                                                                        allowAbsoluteUrls?: boolean;
                                                                                                                                                                                        auth?: AxiosBasicCredentials;
                                                                                                                                                                                        baseURL?: string;
                                                                                                                                                                                        beforeRedirect?: (
                                                                                                                                                                                            options: Record<string, any>,
                                                                                                                                                                                            responseDetails: {
                                                                                                                                                                                                headers: Record<string, string>;
                                                                                                                                                                                                statusCode: HttpStatusCode;
                                                                                                                                                                                            },
                                                                                                                                                                                        ) => void;
                                                                                                                                                                                        cancelToken?: CancelToken;
                                                                                                                                                                                        data?: D;
                                                                                                                                                                                        decompress?: boolean;
                                                                                                                                                                                        env?: { FormData?: new (...args: any[]) => object };
                                                                                                                                                                                        family?: AddressFamily;
                                                                                                                                                                                        fetchOptions?: Record<string, any>;
                                                                                                                                                                                        formSerializer?: FormSerializerOptions;
                                                                                                                                                                                        headers: AxiosRequestHeaders;
                                                                                                                                                                                        httpAgent?: any;
                                                                                                                                                                                        httpsAgent?: any;
                                                                                                                                                                                        insecureHTTPParser?: boolean;
                                                                                                                                                                                        lookup?:
                                                                                                                                                                                            | (
                                                                                                                                                                                                (
                                                                                                                                                                                                    hostname: string,
                                                                                                                                                                                                    options: object,
                                                                                                                                                                                                    cb: (
                                                                                                                                                                                                        err: null | Error,
                                                                                                                                                                                                        address: LookupAddress | LookupAddress[],
                                                                                                                                                                                                        family?: AddressFamily,
                                                                                                                                                                                                    ) => void,
                                                                                                                                                                                                ) => void
                                                                                                                                                                                            )
                                                                                                                                                                                            | (
                                                                                                                                                                                                (
                                                                                                                                                                                                    hostname: string,
                                                                                                                                                                                                    options: object,
                                                                                                                                                                                                ) => Promise<
                                                                                                                                                                                                    | LookupAddress
                                                                                                                                                                                                    | [
                                                                                                                                                                                                        address: LookupAddressEntry
                                                                                                                                                                                                        | LookupAddressEntry[],
                                                                                                                                                                                                        family?: AddressFamily,
                                                                                                                                                                                                    ],
                                                                                                                                                                                                >
                                                                                                                                                                                            );
                                                                                                                                                                                        maxBodyLength?: number;
                                                                                                                                                                                        maxContentLength?: number;
                                                                                                                                                                                        maxRate?: number | [number, number];
                                                                                                                                                                                        maxRedirects?: number;
                                                                                                                                                                                        method?: string;
                                                                                                                                                                                        onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                                                                                                        onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                                                                                                        params?: any;
                                                                                                                                                                                        paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer;
                                                                                                                                                                                        proxy?: false | AxiosProxyConfig;
                                                                                                                                                                                        responseEncoding?: string;
                                                                                                                                                                                        responseType?: ResponseType;
                                                                                                                                                                                        signal?: GenericAbortSignal;
                                                                                                                                                                                        socketPath?: null | string;
                                                                                                                                                                                        timeout?: number;
                                                                                                                                                                                        timeoutErrorMessage?: string;
                                                                                                                                                                                        transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
                                                                                                                                                                                        transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
                                                                                                                                                                                        transitional?: TransitionalOptions;
                                                                                                                                                                                        transport?: any;
                                                                                                                                                                                        url?: string;
                                                                                                                                                                                        validateStatus?: null | ((status: number) => boolean);
                                                                                                                                                                                        withCredentials?: boolean;
                                                                                                                                                                                        withXSRFToken?:
                                                                                                                                                                                            | boolean
                                                                                                                                                                                            | ((config: InternalAxiosRequestConfig) => undefined | boolean);
                                                                                                                                                                                        xsrfCookieName?: string;
                                                                                                                                                                                        xsrfHeaderName?: string;
                                                                                                                                                                                    }

                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                    • D = any

                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                    Index

                                                                                                                                                                                    Properties

                                                                                                                                                                                    adapter? +InternalAxiosRequestConfig | trilium
                                                                                                                                                                                    trilium
                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                      Interface InternalAxiosRequestConfig<D>

                                                                                                                                                                                      interface InternalAxiosRequestConfig<D = any> {
                                                                                                                                                                                          adapter?: AxiosAdapterConfig | AxiosAdapterConfig[];
                                                                                                                                                                                          allowAbsoluteUrls?: boolean;
                                                                                                                                                                                          auth?: AxiosBasicCredentials;
                                                                                                                                                                                          baseURL?: string;
                                                                                                                                                                                          beforeRedirect?: (
                                                                                                                                                                                              options: Record<string, any>,
                                                                                                                                                                                              responseDetails: {
                                                                                                                                                                                                  headers: Record<string, string>;
                                                                                                                                                                                                  statusCode: HttpStatusCode;
                                                                                                                                                                                              },
                                                                                                                                                                                          ) => void;
                                                                                                                                                                                          cancelToken?: CancelToken;
                                                                                                                                                                                          data?: D;
                                                                                                                                                                                          decompress?: boolean;
                                                                                                                                                                                          env?: { FormData?: new (...args: any[]) => object };
                                                                                                                                                                                          family?: AddressFamily;
                                                                                                                                                                                          fetchOptions?: Record<string, any>;
                                                                                                                                                                                          formSerializer?: FormSerializerOptions;
                                                                                                                                                                                          headers: AxiosRequestHeaders;
                                                                                                                                                                                          httpAgent?: any;
                                                                                                                                                                                          httpsAgent?: any;
                                                                                                                                                                                          insecureHTTPParser?: boolean;
                                                                                                                                                                                          lookup?:
                                                                                                                                                                                              | (
                                                                                                                                                                                                  (
                                                                                                                                                                                                      hostname: string,
                                                                                                                                                                                                      options: object,
                                                                                                                                                                                                      cb: (
                                                                                                                                                                                                          err: null | Error,
                                                                                                                                                                                                          address: LookupAddress | LookupAddress[],
                                                                                                                                                                                                          family?: AddressFamily,
                                                                                                                                                                                                      ) => void,
                                                                                                                                                                                                  ) => void
                                                                                                                                                                                              )
                                                                                                                                                                                              | (
                                                                                                                                                                                                  (
                                                                                                                                                                                                      hostname: string,
                                                                                                                                                                                                      options: object,
                                                                                                                                                                                                  ) => Promise<
                                                                                                                                                                                                      | LookupAddress
                                                                                                                                                                                                      | [
                                                                                                                                                                                                          address: LookupAddressEntry
                                                                                                                                                                                                          | LookupAddressEntry[],
                                                                                                                                                                                                          family?: AddressFamily,
                                                                                                                                                                                                      ],
                                                                                                                                                                                                  >
                                                                                                                                                                                              );
                                                                                                                                                                                          maxBodyLength?: number;
                                                                                                                                                                                          maxContentLength?: number;
                                                                                                                                                                                          maxRate?: number | [number, number];
                                                                                                                                                                                          maxRedirects?: number;
                                                                                                                                                                                          method?: string;
                                                                                                                                                                                          onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                                                                                                          onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
                                                                                                                                                                                          params?: any;
                                                                                                                                                                                          paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer;
                                                                                                                                                                                          proxy?: false | AxiosProxyConfig;
                                                                                                                                                                                          responseEncoding?: string;
                                                                                                                                                                                          responseType?: ResponseType;
                                                                                                                                                                                          signal?: GenericAbortSignal;
                                                                                                                                                                                          socketPath?: null | string;
                                                                                                                                                                                          timeout?: number;
                                                                                                                                                                                          timeoutErrorMessage?: string;
                                                                                                                                                                                          transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
                                                                                                                                                                                          transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
                                                                                                                                                                                          transitional?: TransitionalOptions;
                                                                                                                                                                                          transport?: any;
                                                                                                                                                                                          url?: string;
                                                                                                                                                                                          validateStatus?: null | ((status: number) => boolean);
                                                                                                                                                                                          withCredentials?: boolean;
                                                                                                                                                                                          withXSRFToken?:
                                                                                                                                                                                              | boolean
                                                                                                                                                                                              | ((config: InternalAxiosRequestConfig) => undefined | boolean);
                                                                                                                                                                                          xsrfCookieName?: string;
                                                                                                                                                                                          xsrfHeaderName?: string;
                                                                                                                                                                                      }

                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                      • D = any

                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                      Index

                                                                                                                                                                                      Properties

                                                                                                                                                                                      adapter? allowAbsoluteUrls? auth? baseURL? diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.IterableIterator.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.IterableIterator.html index 6baddd271..4d665c85b 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.IterableIterator.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.IterableIterator.html @@ -1,5 +1,5 @@ IterableIterator | trilium
                                                                                                                                                                                      trilium
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Interface IterableIterator<T, TReturn, TNext>

                                                                                                                                                                                        Describes a user-defined Iterator that is also iterable.

                                                                                                                                                                                        -
                                                                                                                                                                                        interface IterableIterator<T, TReturn = any, TNext = any> {
                                                                                                                                                                                            "[iterator]"(): IterableIterator<T, TReturn, TNext>;
                                                                                                                                                                                            next(...__namedParameters: [] | [TNext]): IteratorResult<T, TReturn>;
                                                                                                                                                                                            return(value?: TReturn): IteratorResult<T, TReturn>;
                                                                                                                                                                                            throw(e?: any): IteratorResult<T, TReturn>;
                                                                                                                                                                                        }

                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                        • T
                                                                                                                                                                                        • TReturn = any
                                                                                                                                                                                        • TNext = any

                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                        Index

                                                                                                                                                                                        Methods

                                                                                                                                                                                        [iterator] +
                                                                                                                                                                                        interface IterableIterator<T, TReturn = any, TNext = any> {
                                                                                                                                                                                            "[iterator]"(): IterableIterator<T, TReturn, TNext>;
                                                                                                                                                                                            next(...__namedParameters: [] | [TNext]): IteratorResult<T, TReturn>;
                                                                                                                                                                                            return(value?: TReturn): IteratorResult<T, TReturn>;
                                                                                                                                                                                            throw(e?: any): IteratorResult<T, TReturn>;
                                                                                                                                                                                        }

                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                        • T
                                                                                                                                                                                        • TReturn = any
                                                                                                                                                                                        • TNext = any

                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                        Index

                                                                                                                                                                                        Methods

                                                                                                                                                                                        [iterator] next return? throw? diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.Iterator.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.Iterator.html index b5ae20f45..621bca243 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.Iterator.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.Iterator.html @@ -1,4 +1,4 @@ -Iterator | trilium
                                                                                                                                                                                        trilium
                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                          Interface Iterator<T, TReturn, TNext>

                                                                                                                                                                                          interface Iterator<T, TReturn = any, TNext = any> {
                                                                                                                                                                                              next(...__namedParameters: [] | [TNext]): IteratorResult<T, TReturn>;
                                                                                                                                                                                              return(value?: TReturn): IteratorResult<T, TReturn>;
                                                                                                                                                                                              throw(e?: any): IteratorResult<T, TReturn>;
                                                                                                                                                                                          }

                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                          • T
                                                                                                                                                                                          • TReturn = any
                                                                                                                                                                                          • TNext = any

                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                          Index

                                                                                                                                                                                          Methods

                                                                                                                                                                                          next +Iterator | trilium
                                                                                                                                                                                          trilium
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            Interface Iterator<T, TReturn, TNext>

                                                                                                                                                                                            interface Iterator<T, TReturn = any, TNext = any> {
                                                                                                                                                                                                next(...__namedParameters: [] | [TNext]): IteratorResult<T, TReturn>;
                                                                                                                                                                                                return(value?: TReturn): IteratorResult<T, TReturn>;
                                                                                                                                                                                                throw(e?: any): IteratorResult<T, TReturn>;
                                                                                                                                                                                            }

                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                            • T
                                                                                                                                                                                            • TReturn = any
                                                                                                                                                                                            • TNext = any

                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                            Index

                                                                                                                                                                                            Methods

                                                                                                                                                                                            next return? throw?

                                                                                                                                                                                            Methods

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                            On This Page

                                                                                                                                                                                            Methods
                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteAndBranch.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteAndBranch.html index 8432a1beb..79248c8f9 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteAndBranch.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteAndBranch.html @@ -1,4 +1,4 @@ -NoteAndBranch | trilium
                                                                                                                                                                                            trilium
                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                              Interface NoteAndBranch

                                                                                                                                                                                              interface NoteAndBranch {
                                                                                                                                                                                                  branch: BBranch;
                                                                                                                                                                                                  note: BNote;
                                                                                                                                                                                              }
                                                                                                                                                                                              Index

                                                                                                                                                                                              Properties

                                                                                                                                                                                              branch +NoteAndBranch | trilium
                                                                                                                                                                                              trilium
                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                Interface NoteAndBranch

                                                                                                                                                                                                interface NoteAndBranch {
                                                                                                                                                                                                    branch: BBranch;
                                                                                                                                                                                                    note: BNote;
                                                                                                                                                                                                }
                                                                                                                                                                                                Index

                                                                                                                                                                                                Properties

                                                                                                                                                                                                branch note

                                                                                                                                                                                                Properties

                                                                                                                                                                                                branch: BBranch

                                                                                                                                                                                                object having "note" and "branch" keys representing respective objects

                                                                                                                                                                                                -
                                                                                                                                                                                                note: BNote

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                On This Page

                                                                                                                                                                                                Properties
                                                                                                                                                                                                +
                                                                                                                                                                                                note: BNote

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                On This Page

                                                                                                                                                                                                Properties
                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteParams.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteParams.html index 070943da6..957695954 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteParams.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteParams.html @@ -1,4 +1,4 @@ -NoteParams | trilium
                                                                                                                                                                                                trilium
                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                  Interface NoteParams

                                                                                                                                                                                                  interface NoteParams {
                                                                                                                                                                                                      branchId?: string;
                                                                                                                                                                                                      content: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                      dateCreated?: string;
                                                                                                                                                                                                      ignoreForbiddenParents?: boolean;
                                                                                                                                                                                                      isExpanded?: boolean;
                                                                                                                                                                                                      isProtected?: boolean;
                                                                                                                                                                                                      mime?: string;
                                                                                                                                                                                                      noteId?: string;
                                                                                                                                                                                                      notePosition?: number;
                                                                                                                                                                                                      parentNoteId: string;
                                                                                                                                                                                                      prefix?: string;
                                                                                                                                                                                                      target?: "into";
                                                                                                                                                                                                      templateNoteId?: string;
                                                                                                                                                                                                      title: string;
                                                                                                                                                                                                      type:
                                                                                                                                                                                                          | "canvas"
                                                                                                                                                                                                          | "code"
                                                                                                                                                                                                          | "search"
                                                                                                                                                                                                          | "image"
                                                                                                                                                                                                          | "text"
                                                                                                                                                                                                          | "file"
                                                                                                                                                                                                          | "noteMap"
                                                                                                                                                                                                          | "launcher"
                                                                                                                                                                                                          | "doc"
                                                                                                                                                                                                          | "contentWidget"
                                                                                                                                                                                                          | "relationMap"
                                                                                                                                                                                                          | "render"
                                                                                                                                                                                                          | "mermaid"
                                                                                                                                                                                                          | "book"
                                                                                                                                                                                                          | "webView"
                                                                                                                                                                                                          | "mindMap"
                                                                                                                                                                                                          | "geoMap";
                                                                                                                                                                                                      utcDateCreated?: string;
                                                                                                                                                                                                  }
                                                                                                                                                                                                  Index

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  branchId? +NoteParams | trilium
                                                                                                                                                                                                  trilium
                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                    Interface NoteParams

                                                                                                                                                                                                    interface NoteParams {
                                                                                                                                                                                                        branchId?: string;
                                                                                                                                                                                                        content: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                        dateCreated?: string;
                                                                                                                                                                                                        ignoreForbiddenParents?: boolean;
                                                                                                                                                                                                        isExpanded?: boolean;
                                                                                                                                                                                                        isProtected?: boolean;
                                                                                                                                                                                                        mime?: string;
                                                                                                                                                                                                        noteId?: string;
                                                                                                                                                                                                        notePosition?: number;
                                                                                                                                                                                                        parentNoteId: string;
                                                                                                                                                                                                        prefix?: string;
                                                                                                                                                                                                        target?: "into";
                                                                                                                                                                                                        templateNoteId?: string;
                                                                                                                                                                                                        title: string;
                                                                                                                                                                                                        type:
                                                                                                                                                                                                            | "canvas"
                                                                                                                                                                                                            | "code"
                                                                                                                                                                                                            | "search"
                                                                                                                                                                                                            | "image"
                                                                                                                                                                                                            | "text"
                                                                                                                                                                                                            | "file"
                                                                                                                                                                                                            | "noteMap"
                                                                                                                                                                                                            | "launcher"
                                                                                                                                                                                                            | "doc"
                                                                                                                                                                                                            | "contentWidget"
                                                                                                                                                                                                            | "relationMap"
                                                                                                                                                                                                            | "render"
                                                                                                                                                                                                            | "mermaid"
                                                                                                                                                                                                            | "book"
                                                                                                                                                                                                            | "webView"
                                                                                                                                                                                                            | "mindMap"
                                                                                                                                                                                                            | "geoMap";
                                                                                                                                                                                                        utcDateCreated?: string;
                                                                                                                                                                                                    }
                                                                                                                                                                                                    Index

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    branchId? content dateCreated? ignoreForbiddenParents? @@ -14,11 +14,11 @@ title type utcDateCreated? -

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    branchId?: string

                                                                                                                                                                                                    content

                                                                                                                                                                                                    content: string | Buffer<ArrayBufferLike>
                                                                                                                                                                                                    dateCreated?: string
                                                                                                                                                                                                    ignoreForbiddenParents?: boolean
                                                                                                                                                                                                    isExpanded?: boolean

                                                                                                                                                                                                    default is false

                                                                                                                                                                                                    -
                                                                                                                                                                                                    isProtected?: boolean

                                                                                                                                                                                                    default is false

                                                                                                                                                                                                    -
                                                                                                                                                                                                    mime?: string

                                                                                                                                                                                                    default value is derived from default mimes for type

                                                                                                                                                                                                    -
                                                                                                                                                                                                    noteId?: string

                                                                                                                                                                                                    optionally can force specific noteId

                                                                                                                                                                                                    -
                                                                                                                                                                                                    notePosition?: number

                                                                                                                                                                                                    default is the last existing notePosition in a parent + 10

                                                                                                                                                                                                    -
                                                                                                                                                                                                    parentNoteId: string
                                                                                                                                                                                                    prefix?: string

                                                                                                                                                                                                    default is empty string

                                                                                                                                                                                                    -
                                                                                                                                                                                                    target?: "into"
                                                                                                                                                                                                    templateNoteId?: string
                                                                                                                                                                                                    title: string
                                                                                                                                                                                                    type:
                                                                                                                                                                                                        | "canvas"
                                                                                                                                                                                                        | "code"
                                                                                                                                                                                                        | "search"
                                                                                                                                                                                                        | "image"
                                                                                                                                                                                                        | "text"
                                                                                                                                                                                                        | "file"
                                                                                                                                                                                                        | "noteMap"
                                                                                                                                                                                                        | "launcher"
                                                                                                                                                                                                        | "doc"
                                                                                                                                                                                                        | "contentWidget"
                                                                                                                                                                                                        | "relationMap"
                                                                                                                                                                                                        | "render"
                                                                                                                                                                                                        | "mermaid"
                                                                                                                                                                                                        | "book"
                                                                                                                                                                                                        | "webView"
                                                                                                                                                                                                        | "mindMap"
                                                                                                                                                                                                        | "geoMap"

                                                                                                                                                                                                    text, code, file, image, search, book, relationMap, canvas, webView

                                                                                                                                                                                                    -
                                                                                                                                                                                                    utcDateCreated?: string

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                    Properties
                                                                                                                                                                                                    +

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    branchId?: string

                                                                                                                                                                                                    content

                                                                                                                                                                                                    content: string | Buffer<ArrayBufferLike>
                                                                                                                                                                                                    dateCreated?: string
                                                                                                                                                                                                    ignoreForbiddenParents?: boolean
                                                                                                                                                                                                    isExpanded?: boolean

                                                                                                                                                                                                    default is false

                                                                                                                                                                                                    +
                                                                                                                                                                                                    isProtected?: boolean

                                                                                                                                                                                                    default is false

                                                                                                                                                                                                    +
                                                                                                                                                                                                    mime?: string

                                                                                                                                                                                                    default value is derived from default mimes for type

                                                                                                                                                                                                    +
                                                                                                                                                                                                    noteId?: string

                                                                                                                                                                                                    optionally can force specific noteId

                                                                                                                                                                                                    +
                                                                                                                                                                                                    notePosition?: number

                                                                                                                                                                                                    default is the last existing notePosition in a parent + 10

                                                                                                                                                                                                    +
                                                                                                                                                                                                    parentNoteId: string
                                                                                                                                                                                                    prefix?: string

                                                                                                                                                                                                    default is empty string

                                                                                                                                                                                                    +
                                                                                                                                                                                                    target?: "into"
                                                                                                                                                                                                    templateNoteId?: string
                                                                                                                                                                                                    title: string
                                                                                                                                                                                                    type:
                                                                                                                                                                                                        | "canvas"
                                                                                                                                                                                                        | "code"
                                                                                                                                                                                                        | "search"
                                                                                                                                                                                                        | "image"
                                                                                                                                                                                                        | "text"
                                                                                                                                                                                                        | "file"
                                                                                                                                                                                                        | "noteMap"
                                                                                                                                                                                                        | "launcher"
                                                                                                                                                                                                        | "doc"
                                                                                                                                                                                                        | "contentWidget"
                                                                                                                                                                                                        | "relationMap"
                                                                                                                                                                                                        | "render"
                                                                                                                                                                                                        | "mermaid"
                                                                                                                                                                                                        | "book"
                                                                                                                                                                                                        | "webView"
                                                                                                                                                                                                        | "mindMap"
                                                                                                                                                                                                        | "geoMap"

                                                                                                                                                                                                    text, code, file, image, search, book, relationMap, canvas, webView

                                                                                                                                                                                                    +
                                                                                                                                                                                                    utcDateCreated?: string

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                    Properties
                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.NotePathRecord.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.NotePathRecord.html index 203941a59..f56771203 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.NotePathRecord.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.NotePathRecord.html @@ -1,5 +1,5 @@ -NotePathRecord | trilium
                                                                                                                                                                                                    trilium
                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                      Interface NotePathRecord

                                                                                                                                                                                                      interface NotePathRecord {
                                                                                                                                                                                                          isArchived: boolean;
                                                                                                                                                                                                          isHidden: boolean;
                                                                                                                                                                                                          isInHoistedSubTree: boolean;
                                                                                                                                                                                                          notePath: string[];
                                                                                                                                                                                                      }
                                                                                                                                                                                                      Index

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      isArchived +NotePathRecord | trilium
                                                                                                                                                                                                      trilium
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                        Interface NotePathRecord

                                                                                                                                                                                                        interface NotePathRecord {
                                                                                                                                                                                                            isArchived: boolean;
                                                                                                                                                                                                            isHidden: boolean;
                                                                                                                                                                                                            isInHoistedSubTree: boolean;
                                                                                                                                                                                                            notePath: string[];
                                                                                                                                                                                                        }
                                                                                                                                                                                                        Index

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        isArchived isHidden isInHoistedSubTree notePath -

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        isArchived: boolean
                                                                                                                                                                                                        isHidden: boolean
                                                                                                                                                                                                        isInHoistedSubTree: boolean
                                                                                                                                                                                                        notePath: string[]

                                                                                                                                                                                                        Settings

                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                        Properties
                                                                                                                                                                                                        +

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        isArchived: boolean
                                                                                                                                                                                                        isHidden: boolean
                                                                                                                                                                                                        isInHoistedSubTree: boolean
                                                                                                                                                                                                        notePath: string[]

                                                                                                                                                                                                        Settings

                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                        Properties
                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.NotePojo.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.NotePojo.html index 6111a62e5..1dcae35ca 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.NotePojo.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.NotePojo.html @@ -1,4 +1,4 @@ -NotePojo | trilium
                                                                                                                                                                                                        trilium
                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                          Interface NotePojo

                                                                                                                                                                                                          interface NotePojo {
                                                                                                                                                                                                              blobId?: string;
                                                                                                                                                                                                              dateCreated?: string;
                                                                                                                                                                                                              dateModified?: string;
                                                                                                                                                                                                              isDeleted: boolean;
                                                                                                                                                                                                              isProtected?: boolean;
                                                                                                                                                                                                              mime: string;
                                                                                                                                                                                                              noteId: string;
                                                                                                                                                                                                              title?: string;
                                                                                                                                                                                                              type: string;
                                                                                                                                                                                                              utcDateCreated: string;
                                                                                                                                                                                                              utcDateModified?: string;
                                                                                                                                                                                                          }
                                                                                                                                                                                                          Index

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          blobId? +NotePojo | trilium
                                                                                                                                                                                                          trilium
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            Interface NotePojo

                                                                                                                                                                                                            interface NotePojo {
                                                                                                                                                                                                                blobId?: string;
                                                                                                                                                                                                                dateCreated?: string;
                                                                                                                                                                                                                dateModified?: string;
                                                                                                                                                                                                                isDeleted: boolean;
                                                                                                                                                                                                                isProtected?: boolean;
                                                                                                                                                                                                                mime: string;
                                                                                                                                                                                                                noteId: string;
                                                                                                                                                                                                                title?: string;
                                                                                                                                                                                                                type: string;
                                                                                                                                                                                                                utcDateCreated: string;
                                                                                                                                                                                                                utcDateModified?: string;
                                                                                                                                                                                                            }
                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            blobId? dateCreated? dateModified? isDeleted @@ -9,4 +9,4 @@ type utcDateCreated utcDateModified? -

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            blobId?: string
                                                                                                                                                                                                            dateCreated?: string
                                                                                                                                                                                                            dateModified?: string
                                                                                                                                                                                                            isDeleted: boolean
                                                                                                                                                                                                            isProtected?: boolean
                                                                                                                                                                                                            mime: string
                                                                                                                                                                                                            noteId: string
                                                                                                                                                                                                            title?: string
                                                                                                                                                                                                            type: string
                                                                                                                                                                                                            utcDateCreated: string
                                                                                                                                                                                                            utcDateModified?: string

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                            Properties
                                                                                                                                                                                                            +

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            blobId?: string
                                                                                                                                                                                                            dateCreated?: string
                                                                                                                                                                                                            dateModified?: string
                                                                                                                                                                                                            isDeleted: boolean
                                                                                                                                                                                                            isProtected?: boolean
                                                                                                                                                                                                            mime: string
                                                                                                                                                                                                            noteId: string
                                                                                                                                                                                                            title?: string
                                                                                                                                                                                                            type: string
                                                                                                                                                                                                            utcDateCreated: string
                                                                                                                                                                                                            utcDateModified?: string

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                            Properties
                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteRow.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteRow.html index 515c68326..c102c09a7 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteRow.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.NoteRow.html @@ -1,4 +1,4 @@ -NoteRow | trilium
                                                                                                                                                                                                            trilium
                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                              Interface NoteRow

                                                                                                                                                                                                              interface NoteRow {
                                                                                                                                                                                                                  blobId: string;
                                                                                                                                                                                                                  content?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                  dateCreated: string;
                                                                                                                                                                                                                  dateModified: string;
                                                                                                                                                                                                                  deleteId: string;
                                                                                                                                                                                                                  isDeleted: boolean;
                                                                                                                                                                                                                  isProtected: boolean;
                                                                                                                                                                                                                  mime: string;
                                                                                                                                                                                                                  noteId: string;
                                                                                                                                                                                                                  title: string;
                                                                                                                                                                                                                  type:
                                                                                                                                                                                                                      | "canvas"
                                                                                                                                                                                                                      | "code"
                                                                                                                                                                                                                      | "search"
                                                                                                                                                                                                                      | "image"
                                                                                                                                                                                                                      | "text"
                                                                                                                                                                                                                      | "file"
                                                                                                                                                                                                                      | "noteMap"
                                                                                                                                                                                                                      | "launcher"
                                                                                                                                                                                                                      | "doc"
                                                                                                                                                                                                                      | "contentWidget"
                                                                                                                                                                                                                      | "relationMap"
                                                                                                                                                                                                                      | "render"
                                                                                                                                                                                                                      | "mermaid"
                                                                                                                                                                                                                      | "book"
                                                                                                                                                                                                                      | "webView"
                                                                                                                                                                                                                      | "mindMap"
                                                                                                                                                                                                                      | "geoMap";
                                                                                                                                                                                                                  utcDateCreated: string;
                                                                                                                                                                                                                  utcDateModified: string;
                                                                                                                                                                                                              }
                                                                                                                                                                                                              Index

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              blobId +NoteRow | trilium
                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Interface NoteRow

                                                                                                                                                                                                                interface NoteRow {
                                                                                                                                                                                                                    blobId: string;
                                                                                                                                                                                                                    content?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                    dateCreated: string;
                                                                                                                                                                                                                    dateModified: string;
                                                                                                                                                                                                                    deleteId: string;
                                                                                                                                                                                                                    isDeleted: boolean;
                                                                                                                                                                                                                    isProtected: boolean;
                                                                                                                                                                                                                    mime: string;
                                                                                                                                                                                                                    noteId: string;
                                                                                                                                                                                                                    title: string;
                                                                                                                                                                                                                    type:
                                                                                                                                                                                                                        | "canvas"
                                                                                                                                                                                                                        | "code"
                                                                                                                                                                                                                        | "search"
                                                                                                                                                                                                                        | "image"
                                                                                                                                                                                                                        | "text"
                                                                                                                                                                                                                        | "file"
                                                                                                                                                                                                                        | "noteMap"
                                                                                                                                                                                                                        | "launcher"
                                                                                                                                                                                                                        | "doc"
                                                                                                                                                                                                                        | "contentWidget"
                                                                                                                                                                                                                        | "relationMap"
                                                                                                                                                                                                                        | "render"
                                                                                                                                                                                                                        | "mermaid"
                                                                                                                                                                                                                        | "book"
                                                                                                                                                                                                                        | "webView"
                                                                                                                                                                                                                        | "mindMap"
                                                                                                                                                                                                                        | "geoMap";
                                                                                                                                                                                                                    utcDateCreated: string;
                                                                                                                                                                                                                    utcDateModified: string;
                                                                                                                                                                                                                }
                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                blobId content? dateCreated dateModified @@ -11,4 +11,4 @@ type utcDateCreated utcDateModified -

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                blobId: string

                                                                                                                                                                                                                Optionalcontent

                                                                                                                                                                                                                content?: string | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                dateCreated: string
                                                                                                                                                                                                                dateModified: string
                                                                                                                                                                                                                deleteId: string
                                                                                                                                                                                                                isDeleted: boolean
                                                                                                                                                                                                                isProtected: boolean
                                                                                                                                                                                                                mime: string
                                                                                                                                                                                                                noteId: string
                                                                                                                                                                                                                title: string
                                                                                                                                                                                                                type:
                                                                                                                                                                                                                    | "canvas"
                                                                                                                                                                                                                    | "code"
                                                                                                                                                                                                                    | "search"
                                                                                                                                                                                                                    | "image"
                                                                                                                                                                                                                    | "text"
                                                                                                                                                                                                                    | "file"
                                                                                                                                                                                                                    | "noteMap"
                                                                                                                                                                                                                    | "launcher"
                                                                                                                                                                                                                    | "doc"
                                                                                                                                                                                                                    | "contentWidget"
                                                                                                                                                                                                                    | "relationMap"
                                                                                                                                                                                                                    | "render"
                                                                                                                                                                                                                    | "mermaid"
                                                                                                                                                                                                                    | "book"
                                                                                                                                                                                                                    | "webView"
                                                                                                                                                                                                                    | "mindMap"
                                                                                                                                                                                                                    | "geoMap"
                                                                                                                                                                                                                utcDateCreated: string
                                                                                                                                                                                                                utcDateModified: string

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                blobId: string

                                                                                                                                                                                                                Optionalcontent

                                                                                                                                                                                                                content?: string | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                dateCreated: string
                                                                                                                                                                                                                dateModified: string
                                                                                                                                                                                                                deleteId: string
                                                                                                                                                                                                                isDeleted: boolean
                                                                                                                                                                                                                isProtected: boolean
                                                                                                                                                                                                                mime: string
                                                                                                                                                                                                                noteId: string
                                                                                                                                                                                                                title: string
                                                                                                                                                                                                                type:
                                                                                                                                                                                                                    | "canvas"
                                                                                                                                                                                                                    | "code"
                                                                                                                                                                                                                    | "search"
                                                                                                                                                                                                                    | "image"
                                                                                                                                                                                                                    | "text"
                                                                                                                                                                                                                    | "file"
                                                                                                                                                                                                                    | "noteMap"
                                                                                                                                                                                                                    | "launcher"
                                                                                                                                                                                                                    | "doc"
                                                                                                                                                                                                                    | "contentWidget"
                                                                                                                                                                                                                    | "relationMap"
                                                                                                                                                                                                                    | "render"
                                                                                                                                                                                                                    | "mermaid"
                                                                                                                                                                                                                    | "book"
                                                                                                                                                                                                                    | "webView"
                                                                                                                                                                                                                    | "mindMap"
                                                                                                                                                                                                                    | "geoMap"
                                                                                                                                                                                                                utcDateCreated: string
                                                                                                                                                                                                                utcDateModified: string

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.OptionRow.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.OptionRow.html index 60900b23f..49410f8c4 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.OptionRow.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.OptionRow.html @@ -1,11 +1,11 @@ OptionRow | trilium
                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                  Interface OptionRow

                                                                                                                                                                                                                  Database representation of an option.

                                                                                                                                                                                                                  Options are key-value pairs that are used to store information such as user preferences (for example the current theme, sync server information), but also information about the state of the application).

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  interface OptionRow {
                                                                                                                                                                                                                      isSynced: boolean;
                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                      utcDateModified?: string;
                                                                                                                                                                                                                      value: string;
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  isSynced +
                                                                                                                                                                                                                  interface OptionRow {
                                                                                                                                                                                                                      isSynced: boolean;
                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                      utcDateModified?: string;
                                                                                                                                                                                                                      value: string;
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  isSynced name utcDateModified? value

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  isSynced: boolean

                                                                                                                                                                                                                  true if the value should be synced across multiple instances (e.g. locale) or false if it should be local-only (e.g. theme).

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  name: string

                                                                                                                                                                                                                  The name of the option.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  utcDateModified?: string
                                                                                                                                                                                                                  value: string

                                                                                                                                                                                                                  The value of the option.

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  name: string

                                                                                                                                                                                                                  The name of the option.

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  utcDateModified?: string
                                                                                                                                                                                                                  value: string

                                                                                                                                                                                                                  The value of the option.

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.ParamsSerializerOptions.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.ParamsSerializerOptions.html index ecec49276..cee3fffd1 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.ParamsSerializerOptions.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.ParamsSerializerOptions.html @@ -1,4 +1,4 @@ -ParamsSerializerOptions | trilium
                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                    Interface ParamsSerializerOptions

                                                                                                                                                                                                                    interface ParamsSerializerOptions {
                                                                                                                                                                                                                        dots?: boolean;
                                                                                                                                                                                                                        encode?: ParamEncoder;
                                                                                                                                                                                                                        indexes?: null | boolean;
                                                                                                                                                                                                                        metaTokens?: boolean;
                                                                                                                                                                                                                        serialize?: CustomParamsSerializer;
                                                                                                                                                                                                                        visitor?: SerializerVisitor;
                                                                                                                                                                                                                    }

                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    dots? +ParamsSerializerOptions | trilium
                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                      Interface ParamsSerializerOptions

                                                                                                                                                                                                                      interface ParamsSerializerOptions {
                                                                                                                                                                                                                          dots?: boolean;
                                                                                                                                                                                                                          encode?: ParamEncoder;
                                                                                                                                                                                                                          indexes?: null | boolean;
                                                                                                                                                                                                                          metaTokens?: boolean;
                                                                                                                                                                                                                          serialize?: CustomParamsSerializer;
                                                                                                                                                                                                                          visitor?: SerializerVisitor;
                                                                                                                                                                                                                      }

                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      dots? encode? indexes? metaTokens? diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.Relationship.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.Relationship.html index 14c2ffa00..1fae12caf 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.Relationship.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.Relationship.html @@ -1,3 +1,3 @@ -Relationship | trilium
                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                        Interface Relationship

                                                                                                                                                                                                                        interface Relationship {
                                                                                                                                                                                                                            childNoteId: string;
                                                                                                                                                                                                                            parentNoteId: string;
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        childNoteId +Relationship | trilium
                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                          Interface Relationship

                                                                                                                                                                                                                          interface Relationship {
                                                                                                                                                                                                                              childNoteId: string;
                                                                                                                                                                                                                              parentNoteId: string;
                                                                                                                                                                                                                          }
                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          childNoteId parentNoteId -

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          childNoteId: string
                                                                                                                                                                                                                          parentNoteId: string

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          childNoteId: string
                                                                                                                                                                                                                          parentNoteId: string

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.RevisionRow.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.RevisionRow.html index 70f468514..068ec9e8f 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.RevisionRow.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.RevisionRow.html @@ -1,4 +1,4 @@ -RevisionRow | trilium
                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                            Interface RevisionRow

                                                                                                                                                                                                                            interface RevisionRow {
                                                                                                                                                                                                                                blobId?: string;
                                                                                                                                                                                                                                contentLength?: number;
                                                                                                                                                                                                                                dateCreated: string;
                                                                                                                                                                                                                                dateLastEdited?: string;
                                                                                                                                                                                                                                isProtected?: boolean;
                                                                                                                                                                                                                                mime: string;
                                                                                                                                                                                                                                noteId: string;
                                                                                                                                                                                                                                revisionId?: string;
                                                                                                                                                                                                                                title: string;
                                                                                                                                                                                                                                type:
                                                                                                                                                                                                                                    | "canvas"
                                                                                                                                                                                                                                    | "code"
                                                                                                                                                                                                                                    | "search"
                                                                                                                                                                                                                                    | "image"
                                                                                                                                                                                                                                    | "text"
                                                                                                                                                                                                                                    | "file"
                                                                                                                                                                                                                                    | "noteMap"
                                                                                                                                                                                                                                    | "launcher"
                                                                                                                                                                                                                                    | "doc"
                                                                                                                                                                                                                                    | "contentWidget"
                                                                                                                                                                                                                                    | "relationMap"
                                                                                                                                                                                                                                    | "render"
                                                                                                                                                                                                                                    | "mermaid"
                                                                                                                                                                                                                                    | "book"
                                                                                                                                                                                                                                    | "webView"
                                                                                                                                                                                                                                    | "mindMap"
                                                                                                                                                                                                                                    | "geoMap";
                                                                                                                                                                                                                                utcDateCreated: string;
                                                                                                                                                                                                                                utcDateLastEdited?: string;
                                                                                                                                                                                                                                utcDateModified: string;
                                                                                                                                                                                                                            }
                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            blobId? +RevisionRow | trilium
                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                              Interface RevisionRow

                                                                                                                                                                                                                              interface RevisionRow {
                                                                                                                                                                                                                                  blobId?: string;
                                                                                                                                                                                                                                  contentLength?: number;
                                                                                                                                                                                                                                  dateCreated: string;
                                                                                                                                                                                                                                  dateLastEdited?: string;
                                                                                                                                                                                                                                  isProtected?: boolean;
                                                                                                                                                                                                                                  mime: string;
                                                                                                                                                                                                                                  noteId: string;
                                                                                                                                                                                                                                  revisionId?: string;
                                                                                                                                                                                                                                  title: string;
                                                                                                                                                                                                                                  type:
                                                                                                                                                                                                                                      | "canvas"
                                                                                                                                                                                                                                      | "code"
                                                                                                                                                                                                                                      | "search"
                                                                                                                                                                                                                                      | "image"
                                                                                                                                                                                                                                      | "text"
                                                                                                                                                                                                                                      | "file"
                                                                                                                                                                                                                                      | "noteMap"
                                                                                                                                                                                                                                      | "launcher"
                                                                                                                                                                                                                                      | "doc"
                                                                                                                                                                                                                                      | "contentWidget"
                                                                                                                                                                                                                                      | "relationMap"
                                                                                                                                                                                                                                      | "render"
                                                                                                                                                                                                                                      | "mermaid"
                                                                                                                                                                                                                                      | "book"
                                                                                                                                                                                                                                      | "webView"
                                                                                                                                                                                                                                      | "mindMap"
                                                                                                                                                                                                                                      | "geoMap";
                                                                                                                                                                                                                                  utcDateCreated: string;
                                                                                                                                                                                                                                  utcDateLastEdited?: string;
                                                                                                                                                                                                                                  utcDateModified: string;
                                                                                                                                                                                                                              }
                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              blobId? contentLength? dateCreated dateLastEdited? @@ -11,4 +11,4 @@ utcDateCreated utcDateLastEdited? utcDateModified -

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              blobId?: string
                                                                                                                                                                                                                              contentLength?: number
                                                                                                                                                                                                                              dateCreated: string
                                                                                                                                                                                                                              dateLastEdited?: string
                                                                                                                                                                                                                              isProtected?: boolean
                                                                                                                                                                                                                              mime: string
                                                                                                                                                                                                                              noteId: string
                                                                                                                                                                                                                              revisionId?: string
                                                                                                                                                                                                                              title: string
                                                                                                                                                                                                                              type:
                                                                                                                                                                                                                                  | "canvas"
                                                                                                                                                                                                                                  | "code"
                                                                                                                                                                                                                                  | "search"
                                                                                                                                                                                                                                  | "image"
                                                                                                                                                                                                                                  | "text"
                                                                                                                                                                                                                                  | "file"
                                                                                                                                                                                                                                  | "noteMap"
                                                                                                                                                                                                                                  | "launcher"
                                                                                                                                                                                                                                  | "doc"
                                                                                                                                                                                                                                  | "contentWidget"
                                                                                                                                                                                                                                  | "relationMap"
                                                                                                                                                                                                                                  | "render"
                                                                                                                                                                                                                                  | "mermaid"
                                                                                                                                                                                                                                  | "book"
                                                                                                                                                                                                                                  | "webView"
                                                                                                                                                                                                                                  | "mindMap"
                                                                                                                                                                                                                                  | "geoMap"
                                                                                                                                                                                                                              utcDateCreated: string
                                                                                                                                                                                                                              utcDateLastEdited?: string
                                                                                                                                                                                                                              utcDateModified: string

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              blobId?: string
                                                                                                                                                                                                                              contentLength?: number
                                                                                                                                                                                                                              dateCreated: string
                                                                                                                                                                                                                              dateLastEdited?: string
                                                                                                                                                                                                                              isProtected?: boolean
                                                                                                                                                                                                                              mime: string
                                                                                                                                                                                                                              noteId: string
                                                                                                                                                                                                                              revisionId?: string
                                                                                                                                                                                                                              title: string
                                                                                                                                                                                                                              type:
                                                                                                                                                                                                                                  | "canvas"
                                                                                                                                                                                                                                  | "code"
                                                                                                                                                                                                                                  | "search"
                                                                                                                                                                                                                                  | "image"
                                                                                                                                                                                                                                  | "text"
                                                                                                                                                                                                                                  | "file"
                                                                                                                                                                                                                                  | "noteMap"
                                                                                                                                                                                                                                  | "launcher"
                                                                                                                                                                                                                                  | "doc"
                                                                                                                                                                                                                                  | "contentWidget"
                                                                                                                                                                                                                                  | "relationMap"
                                                                                                                                                                                                                                  | "render"
                                                                                                                                                                                                                                  | "mermaid"
                                                                                                                                                                                                                                  | "book"
                                                                                                                                                                                                                                  | "webView"
                                                                                                                                                                                                                                  | "mindMap"
                                                                                                                                                                                                                                  | "geoMap"
                                                                                                                                                                                                                              utcDateCreated: string
                                                                                                                                                                                                                              utcDateLastEdited?: string
                                                                                                                                                                                                                              utcDateModified: string

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.Root.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.Root.html index 2d7379a4f..5f7ea233f 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.Root.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.Root.html @@ -1,4 +1,4 @@ -Root | trilium
                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                Interface Root

                                                                                                                                                                                                                                interface Root {
                                                                                                                                                                                                                                    contains(container: Element, contained: Element): boolean;
                                                                                                                                                                                                                                    html(options?: CheerioParserOptions): string;
                                                                                                                                                                                                                                    html(
                                                                                                                                                                                                                                        dom: string | Element | Cheerio,
                                                                                                                                                                                                                                        options?: CheerioParserOptions,
                                                                                                                                                                                                                                    ): string;
                                                                                                                                                                                                                                    parseHTML(
                                                                                                                                                                                                                                        data: string,
                                                                                                                                                                                                                                        context?: null | Document,
                                                                                                                                                                                                                                        keepScripts?: boolean,
                                                                                                                                                                                                                                    ): Document[];
                                                                                                                                                                                                                                    root(): Cheerio;
                                                                                                                                                                                                                                    xml(dom?: string | Element | Cheerio): string;
                                                                                                                                                                                                                                    (selector: string): Cheerio;
                                                                                                                                                                                                                                    (selector: string, context: string): Cheerio;
                                                                                                                                                                                                                                    (selector: string, context: Element): Cheerio;
                                                                                                                                                                                                                                    (selector: string, context: Element[]): Cheerio;
                                                                                                                                                                                                                                    (selector: string, context: Cheerio): Cheerio;
                                                                                                                                                                                                                                    (selector: string, context: string, root: string): Cheerio;
                                                                                                                                                                                                                                    (selector: string, context: Element, root: string): Cheerio;
                                                                                                                                                                                                                                    (selector: string, context: Element[], root: string): Cheerio;
                                                                                                                                                                                                                                    (selector: string, context: Cheerio, root: string): Cheerio;
                                                                                                                                                                                                                                    (selector: any): Cheerio;
                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                  • selector: string

                                                                                                                                                                                                                                  Returns Cheerio

                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                  • selector: string
                                                                                                                                                                                                                                  • context: string

                                                                                                                                                                                                                                  Returns Cheerio

                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                  Returns Cheerio

                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                  Returns Cheerio

                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                  Returns Cheerio

                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                  • selector: string
                                                                                                                                                                                                                                  • context: string
                                                                                                                                                                                                                                  • root: string

                                                                                                                                                                                                                                  Returns Cheerio

                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                  • selector: string
                                                                                                                                                                                                                                  • context: Element
                                                                                                                                                                                                                                  • root: string

                                                                                                                                                                                                                                  Returns Cheerio

                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                  • selector: string
                                                                                                                                                                                                                                  • context: Element[]
                                                                                                                                                                                                                                  • root: string

                                                                                                                                                                                                                                  Returns Cheerio

                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                  • selector: string
                                                                                                                                                                                                                                  • context: Cheerio
                                                                                                                                                                                                                                  • root: string

                                                                                                                                                                                                                                  Returns Cheerio

                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                  • selector: any

                                                                                                                                                                                                                                  Returns Cheerio

                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                contains +Root | trilium
                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                  Interface Root

                                                                                                                                                                                                                                  interface Root {
                                                                                                                                                                                                                                      contains(container: Element, contained: Element): boolean;
                                                                                                                                                                                                                                      html(options?: CheerioParserOptions): string;
                                                                                                                                                                                                                                      html(
                                                                                                                                                                                                                                          dom: string | Element | Cheerio,
                                                                                                                                                                                                                                          options?: CheerioParserOptions,
                                                                                                                                                                                                                                      ): string;
                                                                                                                                                                                                                                      parseHTML(
                                                                                                                                                                                                                                          data: string,
                                                                                                                                                                                                                                          context?: null | Document,
                                                                                                                                                                                                                                          keepScripts?: boolean,
                                                                                                                                                                                                                                      ): Document[];
                                                                                                                                                                                                                                      root(): Cheerio;
                                                                                                                                                                                                                                      xml(dom?: string | Element | Cheerio): string;
                                                                                                                                                                                                                                      (selector: string): Cheerio;
                                                                                                                                                                                                                                      (selector: string, context: string): Cheerio;
                                                                                                                                                                                                                                      (selector: string, context: Element): Cheerio;
                                                                                                                                                                                                                                      (selector: string, context: Element[]): Cheerio;
                                                                                                                                                                                                                                      (selector: string, context: Cheerio): Cheerio;
                                                                                                                                                                                                                                      (selector: string, context: string, root: string): Cheerio;
                                                                                                                                                                                                                                      (selector: string, context: Element, root: string): Cheerio;
                                                                                                                                                                                                                                      (selector: string, context: Element[], root: string): Cheerio;
                                                                                                                                                                                                                                      (selector: string, context: Cheerio, root: string): Cheerio;
                                                                                                                                                                                                                                      (selector: any): Cheerio;
                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                    • selector: string

                                                                                                                                                                                                                                    Returns Cheerio

                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                    • selector: string
                                                                                                                                                                                                                                    • context: string

                                                                                                                                                                                                                                    Returns Cheerio

                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                    Returns Cheerio

                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                    Returns Cheerio

                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                    Returns Cheerio

                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                    • selector: string
                                                                                                                                                                                                                                    • context: string
                                                                                                                                                                                                                                    • root: string

                                                                                                                                                                                                                                    Returns Cheerio

                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                    • selector: string
                                                                                                                                                                                                                                    • context: Element
                                                                                                                                                                                                                                    • root: string

                                                                                                                                                                                                                                    Returns Cheerio

                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                    • selector: string
                                                                                                                                                                                                                                    • context: Element[]
                                                                                                                                                                                                                                    • root: string

                                                                                                                                                                                                                                    Returns Cheerio

                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                    • selector: string
                                                                                                                                                                                                                                    • context: Cheerio
                                                                                                                                                                                                                                    • root: string

                                                                                                                                                                                                                                    Returns Cheerio

                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                    • selector: any

                                                                                                                                                                                                                                    Returns Cheerio

                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                  contains html parseHTML root diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.SavingOpts.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.SavingOpts.html index 12fdf59f6..04830e758 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.SavingOpts.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.SavingOpts.html @@ -1,2 +1,2 @@ -SavingOpts | trilium
                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                    Interface SavingOpts

                                                                                                                                                                                                                                    interface SavingOpts {
                                                                                                                                                                                                                                        skipValidation?: boolean;
                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    skipValidation? -

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    skipValidation?: boolean

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                    +SavingOpts | trilium
                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                      Interface SavingOpts

                                                                                                                                                                                                                                      interface SavingOpts {
                                                                                                                                                                                                                                          skipValidation?: boolean;
                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      skipValidation? +

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      skipValidation?: boolean

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.SearchParams.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.SearchParams.html index b84ba7919..c4cb416e3 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.SearchParams.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.SearchParams.html @@ -1,5 +1,5 @@ SearchParams | trilium
                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                        Interface SearchParams

                                                                                                                                                                                                                                        An instance of the frontend api available globally.

                                                                                                                                                                                                                                        api

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        interface SearchParams {
                                                                                                                                                                                                                                            ignoreHoistedNote?: boolean;
                                                                                                                                                                                                                                            includeArchivedNotes?: boolean;
                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        ignoreHoistedNote? +
                                                                                                                                                                                                                                        interface SearchParams {
                                                                                                                                                                                                                                            ignoreHoistedNote?: boolean;
                                                                                                                                                                                                                                            includeArchivedNotes?: boolean;
                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        ignoreHoistedNote? includeArchivedNotes? -

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        ignoreHoistedNote?: boolean
                                                                                                                                                                                                                                        includeArchivedNotes?: boolean

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        ignoreHoistedNote?: boolean
                                                                                                                                                                                                                                        includeArchivedNotes?: boolean

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.Selector.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.Selector.html index 8af5d6ddb..d5a77e6b1 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.Selector.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.Selector.html @@ -1 +1 @@ -Selector | trilium
                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                          Interface Selector

                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                            • selector: string

                                                                                                                                                                                                                                            Returns Cheerio

                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                            • selector: string
                                                                                                                                                                                                                                            • context: string

                                                                                                                                                                                                                                            Returns Cheerio

                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                            Returns Cheerio

                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                            Returns Cheerio

                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                            Returns Cheerio

                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                            • selector: string
                                                                                                                                                                                                                                            • context: string
                                                                                                                                                                                                                                            • root: string

                                                                                                                                                                                                                                            Returns Cheerio

                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                            • selector: string
                                                                                                                                                                                                                                            • context: Element
                                                                                                                                                                                                                                            • root: string

                                                                                                                                                                                                                                            Returns Cheerio

                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                            • selector: string
                                                                                                                                                                                                                                            • context: Element[]
                                                                                                                                                                                                                                            • root: string

                                                                                                                                                                                                                                            Returns Cheerio

                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                            • selector: string
                                                                                                                                                                                                                                            • context: Cheerio
                                                                                                                                                                                                                                            • root: string

                                                                                                                                                                                                                                            Returns Cheerio

                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                            • selector: any

                                                                                                                                                                                                                                            Returns Cheerio

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                          +Selector | trilium
                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Interface Selector

                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                              • selector: string

                                                                                                                                                                                                                                              Returns Cheerio

                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                              • selector: string
                                                                                                                                                                                                                                              • context: string

                                                                                                                                                                                                                                              Returns Cheerio

                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                              Returns Cheerio

                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                              Returns Cheerio

                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                              Returns Cheerio

                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                              • selector: string
                                                                                                                                                                                                                                              • context: string
                                                                                                                                                                                                                                              • root: string

                                                                                                                                                                                                                                              Returns Cheerio

                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                              • selector: string
                                                                                                                                                                                                                                              • context: Element
                                                                                                                                                                                                                                              • root: string

                                                                                                                                                                                                                                              Returns Cheerio

                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                              • selector: string
                                                                                                                                                                                                                                              • context: Element[]
                                                                                                                                                                                                                                              • root: string

                                                                                                                                                                                                                                              Returns Cheerio

                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                              • selector: string
                                                                                                                                                                                                                                              • context: Cheerio
                                                                                                                                                                                                                                              • root: string

                                                                                                                                                                                                                                              Returns Cheerio

                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                              • selector: any

                                                                                                                                                                                                                                              Returns Cheerio

                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.SerializerOptions.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.SerializerOptions.html index 2e4682d8a..fc7426773 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.SerializerOptions.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.SerializerOptions.html @@ -1,4 +1,4 @@ -SerializerOptions | trilium
                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                              Interface SerializerOptions

                                                                                                                                                                                                                                              interface SerializerOptions {
                                                                                                                                                                                                                                                  dots?: boolean;
                                                                                                                                                                                                                                                  indexes?: null | boolean;
                                                                                                                                                                                                                                                  metaTokens?: boolean;
                                                                                                                                                                                                                                                  visitor?: SerializerVisitor;
                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              dots? +SerializerOptions | trilium
                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Interface SerializerOptions

                                                                                                                                                                                                                                                interface SerializerOptions {
                                                                                                                                                                                                                                                    dots?: boolean;
                                                                                                                                                                                                                                                    indexes?: null | boolean;
                                                                                                                                                                                                                                                    metaTokens?: boolean;
                                                                                                                                                                                                                                                    visitor?: SerializerVisitor;
                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                dots? indexes? metaTokens? visitor? diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.StaticEventEmitterIteratorOptions.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.StaticEventEmitterIteratorOptions.html index 7787a73dd..20f0f571f 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.StaticEventEmitterIteratorOptions.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.StaticEventEmitterIteratorOptions.html @@ -1,4 +1,4 @@ -StaticEventEmitterIteratorOptions | trilium
                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                  Interface StaticEventEmitterIteratorOptions

                                                                                                                                                                                                                                                  interface StaticEventEmitterIteratorOptions {
                                                                                                                                                                                                                                                      close?: string[];
                                                                                                                                                                                                                                                      highWaterMark?: number;
                                                                                                                                                                                                                                                      lowWaterMark?: number;
                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                  close? +StaticEventEmitterIteratorOptions | trilium
                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Interface StaticEventEmitterIteratorOptions

                                                                                                                                                                                                                                                    interface StaticEventEmitterIteratorOptions {
                                                                                                                                                                                                                                                        close?: string[];
                                                                                                                                                                                                                                                        highWaterMark?: number;
                                                                                                                                                                                                                                                        lowWaterMark?: number;
                                                                                                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                    close? highWaterMark? lowWaterMark? signal? diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.StaticEventEmitterOptions.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.StaticEventEmitterOptions.html index eb7df8494..2cdeaf564 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.StaticEventEmitterOptions.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.StaticEventEmitterOptions.html @@ -1,3 +1,3 @@ -StaticEventEmitterOptions | trilium
                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                      Interface StaticEventEmitterOptions

                                                                                                                                                                                                                                                      interface StaticEventEmitterOptions {
                                                                                                                                                                                                                                                          signal?: AbortSignal;
                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                      signal? +StaticEventEmitterOptions | trilium
                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Interface StaticEventEmitterOptions

                                                                                                                                                                                                                                                        interface StaticEventEmitterOptions {
                                                                                                                                                                                                                                                            signal?: AbortSignal;
                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        signal?

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        signal?: AbortSignal

                                                                                                                                                                                                                                                        Can be used to cancel awaiting events.

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Backend_Script_API._internal_.TaskData.html b/docs/backend_api/interfaces/Backend_Script_API._internal_.TaskData.html index 5b6bd325f..51909c782 100644 --- a/docs/backend_api/interfaces/Backend_Script_API._internal_.TaskData.html +++ b/docs/backend_api/interfaces/Backend_Script_API._internal_.TaskData.html @@ -1,6 +1,6 @@ -TaskData | trilium
                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                          Interface TaskData

                                                                                                                                                                                                                                                          interface TaskData {
                                                                                                                                                                                                                                                              codeImportedAsCode?: boolean;
                                                                                                                                                                                                                                                              replaceUnderscoresWithSpaces?: boolean;
                                                                                                                                                                                                                                                              safeImport?: boolean;
                                                                                                                                                                                                                                                              shrinkImages?: boolean;
                                                                                                                                                                                                                                                              textImportedAsText?: boolean;
                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          codeImportedAsCode? +TaskData | trilium
                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Interface TaskData

                                                                                                                                                                                                                                                            interface TaskData {
                                                                                                                                                                                                                                                                codeImportedAsCode?: boolean;
                                                                                                                                                                                                                                                                replaceUnderscoresWithSpaces?: boolean;
                                                                                                                                                                                                                                                                safeImport?: boolean;
                                                                                                                                                                                                                                                                shrinkImages?: boolean;
                                                                                                                                                                                                                                                                textImportedAsText?: boolean;
                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                            codeImportedAsCode? replaceUnderscoresWithSpaces? safeImport? shrinkImages? textImportedAsText? -

                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                            codeImportedAsCode?: boolean
                                                                                                                                                                                                                                                            replaceUnderscoresWithSpaces?: boolean
                                                                                                                                                                                                                                                            safeImport?: boolean
                                                                                                                                                                                                                                                            shrinkImages?: boolean
                                                                                                                                                                                                                                                            textImportedAsText?: boolean

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                            codeImportedAsCode?: boolean
                                                                                                                                                                                                                                                            replaceUnderscoresWithSpaces?: boolean
                                                                                                                                                                                                                                                            safeImport?: boolean
                                                                                                                                                                                                                                                            shrinkImages?: boolean
                                                                                                                                                                                                                                                            textImportedAsText?: boolean

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Frontend_Script_API.Api.html b/docs/backend_api/interfaces/Frontend_Script_API.Api.html new file mode 100644 index 000000000..061d0dc2d --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API.Api.html @@ -0,0 +1,182 @@ +Api | trilium
                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                              Interface Api

                                                                                                                                                                                                                                                              interface Api {
                                                                                                                                                                                                                                                                  $container: null | JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                  BasicWidget: typeof default;
                                                                                                                                                                                                                                                                  bindGlobalShortcut: (
                                                                                                                                                                                                                                                                      keyboardShortcut: string,
                                                                                                                                                                                                                                                                      handler: null | Handler,
                                                                                                                                                                                                                                                                      namespace?: null | string,
                                                                                                                                                                                                                                                                  ) => void;
                                                                                                                                                                                                                                                                  createLink: (
                                                                                                                                                                                                                                                                      notePath: undefined | string,
                                                                                                                                                                                                                                                                      options?: CreateLinkOptions,
                                                                                                                                                                                                                                                                  ) => Promise<JQuery<HTMLElement>>;
                                                                                                                                                                                                                                                                  createNoteLink: (
                                                                                                                                                                                                                                                                      notePath: undefined | string,
                                                                                                                                                                                                                                                                      options?: CreateLinkOptions,
                                                                                                                                                                                                                                                                  ) => Promise<JQuery<HTMLElement>>;
                                                                                                                                                                                                                                                                  currentNote: FNote;
                                                                                                                                                                                                                                                                  dayjs: __module;
                                                                                                                                                                                                                                                                  formatDateISO: (date: Date) => string;
                                                                                                                                                                                                                                                                  formatNoteSize: (size: number) => string;
                                                                                                                                                                                                                                                                  formatSize: (size: number) => string;
                                                                                                                                                                                                                                                                  getDayNote: (date: string) => Promise<null | FNote>;
                                                                                                                                                                                                                                                                  getMonthNote: (month: string) => Promise<null | FNote>;
                                                                                                                                                                                                                                                                  getQuarterNote: (quarter: string) => Promise<null | FNote>;
                                                                                                                                                                                                                                                                  getTodayNote: () => Promise<null | FNote>;
                                                                                                                                                                                                                                                                  getWeekFirstDayNote: (date: string) => Promise<null | FNote>;
                                                                                                                                                                                                                                                                  getWeekNote: (week: string) => Promise<null | FNote>;
                                                                                                                                                                                                                                                                  getYearNote: (year: string) => Promise<null | FNote>;
                                                                                                                                                                                                                                                                  logMessages: Record<string, string[]>;
                                                                                                                                                                                                                                                                  logSpacedUpdates: Record<string, default>;
                                                                                                                                                                                                                                                                  NoteContextAwareWidget: typeof NoteContextAwareWidget;
                                                                                                                                                                                                                                                                  originEntity: unknown;
                                                                                                                                                                                                                                                                  parseDate: (str: string) => Date;
                                                                                                                                                                                                                                                                  protectNote: (
                                                                                                                                                                                                                                                                      noteId: string,
                                                                                                                                                                                                                                                                      protect: boolean,
                                                                                                                                                                                                                                                                      includingSubtree: boolean,
                                                                                                                                                                                                                                                                  ) => Promise<void>;
                                                                                                                                                                                                                                                                  protectSubTree: (
                                                                                                                                                                                                                                                                      noteId: string,
                                                                                                                                                                                                                                                                      protect: boolean,
                                                                                                                                                                                                                                                                      includingSubtree: boolean,
                                                                                                                                                                                                                                                                  ) => Promise<void>;
                                                                                                                                                                                                                                                                  randomString: (len: number) => string;
                                                                                                                                                                                                                                                                  RightPanelWidget: typeof RightPanelWidget;
                                                                                                                                                                                                                                                                  setupElementTooltip: ($el: JQuery<HTMLElement>) => void;
                                                                                                                                                                                                                                                                  showConfirmDialog: (message: string) => Promise<unknown>;
                                                                                                                                                                                                                                                                  showError: (message: string, delay?: number) => void;
                                                                                                                                                                                                                                                                  showInfoDialog: (message: string) => Promise<unknown>;
                                                                                                                                                                                                                                                                  showMessage: (message: string, delay?: number) => void;
                                                                                                                                                                                                                                                                  showPromptDialog: (props: PromptDialogOptions) => Promise<null | string>;
                                                                                                                                                                                                                                                                  startNote: FNote;
                                                                                                                                                                                                                                                                  triggerCommand: <K extends keyof CommandMappings>(
                                                                                                                                                                                                                                                                      name: K,
                                                                                                                                                                                                                                                                      _data?: CommandMappings[K],
                                                                                                                                                                                                                                                                  ) => undefined | null | Promise<unknown>;
                                                                                                                                                                                                                                                                  triggerEvent: <K extends EventNames>(
                                                                                                                                                                                                                                                                      name: K,
                                                                                                                                                                                                                                                                      data: EventData<K>,
                                                                                                                                                                                                                                                                  ) => undefined | null | Promise<unknown>;
                                                                                                                                                                                                                                                                  waitUntilSynced: () => Promise<void>;
                                                                                                                                                                                                                                                                  activateNewNote(notePath: string): Promise<void>;
                                                                                                                                                                                                                                                                  activateNote(notePath: string): Promise<void>;
                                                                                                                                                                                                                                                                  addButtonToToolbar(opts: AddToToolbarOpts): void;
                                                                                                                                                                                                                                                                  addTextToActiveContextEditor(text: string): void;
                                                                                                                                                                                                                                                                  getActiveContext(): NoteContext;
                                                                                                                                                                                                                                                                  getActiveContextCodeEditor(): Promise<unknown>;
                                                                                                                                                                                                                                                                  getActiveContextNote(): FNote;
                                                                                                                                                                                                                                                                  getActiveContextNotePath(): null | string;
                                                                                                                                                                                                                                                                  getActiveContextTextEditor(): Promise<unknown>;
                                                                                                                                                                                                                                                                  getActiveMainContext(): NoteContext;
                                                                                                                                                                                                                                                                  getActiveNoteDetailWidget(): Promise<default>;
                                                                                                                                                                                                                                                                  getComponentByEl(el: HTMLElement): default;
                                                                                                                                                                                                                                                                  getInstanceName(): string;
                                                                                                                                                                                                                                                                  getMainNoteContexts(): NoteContext[];
                                                                                                                                                                                                                                                                  getNote(noteId: string): Promise<null | FNote>;
                                                                                                                                                                                                                                                                  getNoteContexts(): NoteContext[];
                                                                                                                                                                                                                                                                  getNotes(
                                                                                                                                                                                                                                                                      noteIds: string[],
                                                                                                                                                                                                                                                                      silentNotFoundError?: boolean,
                                                                                                                                                                                                                                                                  ): Promise<FNote[]>;
                                                                                                                                                                                                                                                                  log(message: string): void;
                                                                                                                                                                                                                                                                  openSplitWithNote(notePath: string, activate: boolean): Promise<void>;
                                                                                                                                                                                                                                                                  openTabWithNote(notePath: string, activate: boolean): Promise<void>;
                                                                                                                                                                                                                                                                  refreshIncludedNote(includedNoteId: string): void;
                                                                                                                                                                                                                                                                  reloadNotes(noteIds: string[]): Promise<void>;
                                                                                                                                                                                                                                                                  runAsyncOnBackendWithManualTransactionHandling(
                                                                                                                                                                                                                                                                      func: Func,
                                                                                                                                                                                                                                                                      params: unknown[],
                                                                                                                                                                                                                                                                  ): unknown;
                                                                                                                                                                                                                                                                  runOnBackend(func: Func, params: unknown[]): unknown;
                                                                                                                                                                                                                                                                  searchForNote(searchString: string): Promise<null | FNote>;
                                                                                                                                                                                                                                                                  searchForNotes(searchString: string): Promise<FNote[]>;
                                                                                                                                                                                                                                                                  setHoistedNoteId(noteId: string): void;
                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              $container +BasicWidget +bindGlobalShortcut +createLink +createNoteLink +currentNote +dayjs +formatDateISO +formatNoteSize +formatSize +getDayNote +getMonthNote +getQuarterNote +getTodayNote +getWeekFirstDayNote +getWeekNote +getYearNote +logMessages +logSpacedUpdates +NoteContextAwareWidget +originEntity +parseDate +protectNote +protectSubTree +randomString +RightPanelWidget +setupElementTooltip +showConfirmDialog +showError +showInfoDialog +showMessage +showPromptDialog +startNote +triggerCommand +triggerEvent +waitUntilSynced +

                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                              activateNewNote +activateNote +addButtonToToolbar +addTextToActiveContextEditor +getActiveContext +getActiveContextCodeEditor +getActiveContextNote +getActiveContextNotePath +getActiveContextTextEditor +getActiveMainContext +getActiveNoteDetailWidget +getComponentByEl +getInstanceName +getMainNoteContexts +getNote +getNoteContexts +getNotes +log +openSplitWithNote +openTabWithNote +refreshIncludedNote +reloadNotes +runAsyncOnBackendWithManualTransactionHandling +runOnBackend +searchForNote +searchForNotes +setHoistedNoteId +

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              $container: null | JQuery<HTMLElement>

                                                                                                                                                                                                                                                              Container of all the rendered script content

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              BasicWidget: typeof default
                                                                                                                                                                                                                                                              bindGlobalShortcut: (
                                                                                                                                                                                                                                                                  keyboardShortcut: string,
                                                                                                                                                                                                                                                                  handler: null | Handler,
                                                                                                                                                                                                                                                                  namespace?: null | string,
                                                                                                                                                                                                                                                              ) => void

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                • (
                                                                                                                                                                                                                                                                      keyboardShortcut: string,
                                                                                                                                                                                                                                                                      handler: null | Handler,
                                                                                                                                                                                                                                                                      namespace?: null | string,
                                                                                                                                                                                                                                                                  ): void

                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                  • keyboardShortcut: string

                                                                                                                                                                                                                                                                    e.g. "ctrl+shift+a"

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • handler: null | Handler
                                                                                                                                                                                                                                                                  • namespace: null | string = null

                                                                                                                                                                                                                                                                    specify namespace of the handler for the cases where call for bind may be repeated. +If a handler with this ID exists, it's replaced by the new handler.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                              createLink: (
                                                                                                                                                                                                                                                                  notePath: undefined | string,
                                                                                                                                                                                                                                                                  options?: CreateLinkOptions,
                                                                                                                                                                                                                                                              ) => Promise<JQuery<HTMLElement>>

                                                                                                                                                                                                                                                              Create a note link (jQuery object) for given note.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                • (
                                                                                                                                                                                                                                                                      notePath: undefined | string,
                                                                                                                                                                                                                                                                      options?: CreateLinkOptions,
                                                                                                                                                                                                                                                                  ): Promise<JQuery<HTMLElement>>

                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                  Returns Promise<JQuery<HTMLElement>>

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • jQuery element with the link (wrapped in )
                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                              createNoteLink: (
                                                                                                                                                                                                                                                                  notePath: undefined | string,
                                                                                                                                                                                                                                                                  options?: CreateLinkOptions,
                                                                                                                                                                                                                                                              ) => Promise<JQuery<HTMLElement>>
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • use api.createLink() instead
                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              currentNote: FNote

                                                                                                                                                                                                                                                              Note where the script is currently executing, i.e. the note where the currently executing source code is written.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              dayjs: __module

                                                                                                                                                                                                                                                              day.js library for date manipulation. +See https://day.js.org for documentation

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              https://day.js.org

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              formatDateISO: (date: Date) => string

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                • (date: Date): string

                                                                                                                                                                                                                                                                • this is producing local time! *

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                  • date: Date

                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                              date in YYYY-MM-DD format

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              formatNoteSize: (size: number) => string

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                • (size: number): string

                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                  • size: number

                                                                                                                                                                                                                                                                    in bytes

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                  formatted string

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • use api.formatSize()
                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              formatSize: (size: number) => string

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                • (size: number): string

                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                  • size: number

                                                                                                                                                                                                                                                                    in bytes

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                  formatted string

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                              getDayNote: (date: string) => Promise<null | FNote>

                                                                                                                                                                                                                                                              Returns day note for a given date. If it doesn't exist, it is automatically created.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                • (date: string): Promise<null | FNote>

                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                  • date: string

                                                                                                                                                                                                                                                                    e.g. "2019-04-29"

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                  Returns Promise<null | FNote>

                                                                                                                                                                                                                                                              getMonthNote: (month: string) => Promise<null | FNote>

                                                                                                                                                                                                                                                              Returns month-note. If it doesn't exist, it is automatically created.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                • (month: string): Promise<null | FNote>

                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                  • month: string

                                                                                                                                                                                                                                                                    e.g. "2019-04"

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                  Returns Promise<null | FNote>

                                                                                                                                                                                                                                                              getQuarterNote: (quarter: string) => Promise<null | FNote>

                                                                                                                                                                                                                                                              Returns quarter note for given date. If such a note doesn't exist, it is automatically created.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              getTodayNote: () => Promise<null | FNote>

                                                                                                                                                                                                                                                              Returns date-note for today. If it doesn't exist, it is automatically created.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              getWeekFirstDayNote: (date: string) => Promise<null | FNote>

                                                                                                                                                                                                                                                              Returns day note for the first date of the week of the given date. If it doesn't exist, it is automatically created.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                • (date: string): Promise<null | FNote>

                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                  • date: string

                                                                                                                                                                                                                                                                    e.g. "2019-04-29"

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                  Returns Promise<null | FNote>

                                                                                                                                                                                                                                                              getWeekNote: (week: string) => Promise<null | FNote>

                                                                                                                                                                                                                                                              Returns week note for given date. If such a note doesn't exist, it is automatically created.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              getYearNote: (year: string) => Promise<null | FNote>

                                                                                                                                                                                                                                                              Returns year-note. If it doesn't exist, it is automatically created.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                • (year: string): Promise<null | FNote>

                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                  • year: string

                                                                                                                                                                                                                                                                    e.g. "2019"

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                  Returns Promise<null | FNote>

                                                                                                                                                                                                                                                              logMessages: Record<string, string[]>
                                                                                                                                                                                                                                                              logSpacedUpdates: Record<string, default>
                                                                                                                                                                                                                                                              NoteContextAwareWidget: typeof NoteContextAwareWidget
                                                                                                                                                                                                                                                              originEntity: unknown

                                                                                                                                                                                                                                                              Entity whose event triggered this execution.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              parseDate: (str: string) => Date
                                                                                                                                                                                                                                                              protectNote: (
                                                                                                                                                                                                                                                                  noteId: string,
                                                                                                                                                                                                                                                                  protect: boolean,
                                                                                                                                                                                                                                                                  includingSubtree: boolean,
                                                                                                                                                                                                                                                              ) => Promise<void>

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                • (noteId: string, protect: boolean, includingSubtree: boolean): Promise<void>

                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                  • noteId: string
                                                                                                                                                                                                                                                                  • protect: boolean

                                                                                                                                                                                                                                                                    true to protect note, false to unprotect

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • includingSubtree: boolean

                                                                                                                                                                                                                                                                  Returns Promise<void>

                                                                                                                                                                                                                                                              protectSubTree: (
                                                                                                                                                                                                                                                                  noteId: string,
                                                                                                                                                                                                                                                                  protect: boolean,
                                                                                                                                                                                                                                                                  includingSubtree: boolean,
                                                                                                                                                                                                                                                              ) => Promise<void>

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                • (noteId: string, protect: boolean, includingSubtree: boolean): Promise<void>

                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                  • noteId: string
                                                                                                                                                                                                                                                                  • protect: boolean

                                                                                                                                                                                                                                                                    true to protect subtree, false to unprotect

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • includingSubtree: boolean

                                                                                                                                                                                                                                                                  Returns Promise<void>

                                                                                                                                                                                                                                                              randomString: (len: number) => string

                                                                                                                                                                                                                                                              Return randomly generated string of given length. This random string generation is NOT cryptographically secure.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                • (len: number): string

                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                  • len: number

                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                  random string

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                              RightPanelWidget: typeof RightPanelWidget
                                                                                                                                                                                                                                                              setupElementTooltip: ($el: JQuery<HTMLElement>) => void

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                • ($el: JQuery<HTMLElement>): void

                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                  • $el: JQuery<HTMLElement>

                                                                                                                                                                                                                                                                    jquery object on which to set up the tooltip

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                              showConfirmDialog: (message: string) => Promise<unknown>

                                                                                                                                                                                                                                                              Show confirm dialog to the user.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                • (message: string): Promise<unknown>

                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                  • message: string

                                                                                                                                                                                                                                                                  Returns Promise<unknown>

                                                                                                                                                                                                                                                                  promise resolving to true if the user confirmed

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                              showError: (message: string, delay?: number) => void

                                                                                                                                                                                                                                                              Show an error toast message to the user.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              showInfoDialog: (message: string) => Promise<unknown>

                                                                                                                                                                                                                                                              Show an info dialog to the user.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              showMessage: (message: string, delay?: number) => void

                                                                                                                                                                                                                                                              Show an info toast message to the user.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              showPromptDialog: (props: PromptDialogOptions) => Promise<null | string>

                                                                                                                                                                                                                                                              Show prompt dialog to the user.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                              startNote: FNote

                                                                                                                                                                                                                                                              Note where the script started executing, i.e., the (event) entrypoint of the current script execution.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              triggerCommand: <K extends keyof CommandMappings>(
                                                                                                                                                                                                                                                                  name: K,
                                                                                                                                                                                                                                                                  _data?: CommandMappings[K],
                                                                                                                                                                                                                                                              ) => undefined | null | Promise<unknown>

                                                                                                                                                                                                                                                              Trigger command. This is a very low-level API which should be avoided if possible.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              triggerEvent: <K extends EventNames>(
                                                                                                                                                                                                                                                                  name: K,
                                                                                                                                                                                                                                                                  data: EventData<K>,
                                                                                                                                                                                                                                                              ) => undefined | null | Promise<unknown>

                                                                                                                                                                                                                                                              Trigger event. This is a very low-level API which should be avoided if possible.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              waitUntilSynced: () => Promise<void>

                                                                                                                                                                                                                                                              Trilium runs in a backend and frontend process, when something is changed on the backend from a script, +frontend will get asynchronously synchronized.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              This method returns a promise which resolves once all the backend -> frontend synchronization is finished. +Typical use case is when a new note has been created, we should wait until it is synced into frontend and only then activate it.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                              • Activates newly created note. Compared to this.activateNote() also makes sure that frontend has been fully synced.

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • notePath: string

                                                                                                                                                                                                                                                                  (or noteId)

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                Returns Promise<void>

                                                                                                                                                                                                                                                              • Adds a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                you can now create/modify launchers in the top-left Menu -> Configure Launchbar +for special needs there's also backend API's createOrUpdateLauncher()

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                              • Returns list of notes. If note is missing from the cache, it's loaded.

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                This is often used to bulk-fill the cache with notes which would have to be picked one by one +otherwise (by e.g. createLink())

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • noteIds: string[]
                                                                                                                                                                                                                                                                • OptionalsilentNotFoundError: boolean

                                                                                                                                                                                                                                                                  don't report error if the note is not found

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                Returns Promise<FNote[]>

                                                                                                                                                                                                                                                              • Open a note in a new split.

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • notePath: string

                                                                                                                                                                                                                                                                  (or noteId)

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • activate: boolean

                                                                                                                                                                                                                                                                  set to true to activate the new split, false to stay on the current split

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                Returns Promise<void>

                                                                                                                                                                                                                                                              • Open a note in a new tab.

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • notePath: string

                                                                                                                                                                                                                                                                  (or noteId)

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • activate: boolean

                                                                                                                                                                                                                                                                  set to true to activate the new tab, false to stay on the current tab

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                Returns Promise<void>

                                                                                                                                                                                                                                                              • This will refresh all currently opened notes which have included note specified in the parameter

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • includedNoteId: string

                                                                                                                                                                                                                                                                  noteId of the included note

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                              • Executes given anonymous function on the backend. +Internally this serializes the anonymous function into string and sends it to backend via AJAX. +This function is meant for advanced needs where an async function is necessary. +In this case, the automatic request-scoped transaction management is not applied, +and you need to manually define transaction via api.transactional().

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                If you have a synchronous function, please use api.runOnBackend().

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • func: Func

                                                                                                                                                                                                                                                                  (synchronous) function to be executed on the backend

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • params: unknown[]

                                                                                                                                                                                                                                                                  list of parameters to the anonymous function to be sent to backend

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                Returns unknown

                                                                                                                                                                                                                                                                return value of the executed function on the backend

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                              • Executes given anonymous function on the backend. +Internally this serializes the anonymous function into string and sends it to backend via AJAX. +Please make sure that the supplied function is synchronous. Only sync functions will work correctly +with transaction management. If you really know what you're doing, you can call api.runAsyncOnBackendWithManualTransactionHandling()

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • func: Func

                                                                                                                                                                                                                                                                  (synchronous) function to be executed on the backend

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • params: unknown[]

                                                                                                                                                                                                                                                                  list of parameters to the anonymous function to be sent to backend

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                Returns unknown

                                                                                                                                                                                                                                                                return value of the executed function on the backend

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.AddToToolbarOpts.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.AddToToolbarOpts.html new file mode 100644 index 000000000..886e70a90 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.AddToToolbarOpts.html @@ -0,0 +1,13 @@ +AddToToolbarOpts | trilium
                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                Interface AddToToolbarOpts

                                                                                                                                                                                                                                                                An instance of the frontend api available globally.

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                api

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                interface AddToToolbarOpts {
                                                                                                                                                                                                                                                                    action: () => void;
                                                                                                                                                                                                                                                                    icon: string;
                                                                                                                                                                                                                                                                    id: string;
                                                                                                                                                                                                                                                                    shortcut: string;
                                                                                                                                                                                                                                                                    title: string;
                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                action +icon +id +shortcut +title +

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                action: () => void

                                                                                                                                                                                                                                                                callback handling the click on the button

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                icon: string

                                                                                                                                                                                                                                                                name of the boxicon to be used (e.g. "time" for "bx-time" icon)

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                id: string

                                                                                                                                                                                                                                                                id of the button, used to identify the old instances of this button to be replaced +ID is optional because of BC, but not specifying it is deprecated. ID can be alphanumeric only.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                shortcut: string

                                                                                                                                                                                                                                                                keyboard shortcut for the button, e.g. "alt+t"

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                title: string

                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Attribute.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Attribute.html new file mode 100644 index 000000000..c68d5697a --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Attribute.html @@ -0,0 +1,9 @@ +Attribute | trilium
                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                  Interface Attribute

                                                                                                                                                                                                                                                                  interface Attribute {
                                                                                                                                                                                                                                                                      attributeId?: string;
                                                                                                                                                                                                                                                                      endIndex?: number;
                                                                                                                                                                                                                                                                      isInheritable?: boolean;
                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                      noteId?: string;
                                                                                                                                                                                                                                                                      startIndex?: number;
                                                                                                                                                                                                                                                                      type: AttributeType;
                                                                                                                                                                                                                                                                      value?: string;
                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  attributeId? +endIndex? +isInheritable? +name +noteId? +startIndex? +type +value? +

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  attributeId?: string
                                                                                                                                                                                                                                                                  endIndex?: number
                                                                                                                                                                                                                                                                  isInheritable?: boolean
                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                  noteId?: string
                                                                                                                                                                                                                                                                  startIndex?: number
                                                                                                                                                                                                                                                                  type: AttributeType
                                                                                                                                                                                                                                                                  value?: string

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.BaseJQueryEventObject.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.BaseJQueryEventObject.html new file mode 100644 index 000000000..897166b01 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.BaseJQueryEventObject.html @@ -0,0 +1,95 @@ +BaseJQueryEventObject | trilium
                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                    Interface BaseJQueryEventObject

                                                                                                                                                                                                                                                                    ​ Deprecated. Use JQuery.Event.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    interface BaseJQueryEventObject {
                                                                                                                                                                                                                                                                        AT_TARGET: 2;
                                                                                                                                                                                                                                                                        bubbles: boolean;
                                                                                                                                                                                                                                                                        BUBBLING_PHASE: 3;
                                                                                                                                                                                                                                                                        cancelable: boolean;
                                                                                                                                                                                                                                                                        cancelBubble: boolean;
                                                                                                                                                                                                                                                                        CAPTURING_PHASE: 1;
                                                                                                                                                                                                                                                                        composed: boolean;
                                                                                                                                                                                                                                                                        currentTarget: Element;
                                                                                                                                                                                                                                                                        data: any;
                                                                                                                                                                                                                                                                        defaultPrevented: boolean;
                                                                                                                                                                                                                                                                        delegateTarget: Element;
                                                                                                                                                                                                                                                                        eventPhase: number;
                                                                                                                                                                                                                                                                        isTrusted: boolean;
                                                                                                                                                                                                                                                                        metaKey: boolean;
                                                                                                                                                                                                                                                                        namespace: string;
                                                                                                                                                                                                                                                                        NONE: 0;
                                                                                                                                                                                                                                                                        originalEvent: Event;
                                                                                                                                                                                                                                                                        pageX: number;
                                                                                                                                                                                                                                                                        pageY: number;
                                                                                                                                                                                                                                                                        relatedTarget: Element;
                                                                                                                                                                                                                                                                        result: any;
                                                                                                                                                                                                                                                                        returnValue: boolean;
                                                                                                                                                                                                                                                                        srcElement: null | EventTarget;
                                                                                                                                                                                                                                                                        target: Element;
                                                                                                                                                                                                                                                                        timeStamp: number;
                                                                                                                                                                                                                                                                        type: string;
                                                                                                                                                                                                                                                                        which: number;
                                                                                                                                                                                                                                                                        composedPath(): EventTarget[];
                                                                                                                                                                                                                                                                        initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
                                                                                                                                                                                                                                                                        isDefaultPrevented(): boolean;
                                                                                                                                                                                                                                                                        isImmediatePropagationStopped(): boolean;
                                                                                                                                                                                                                                                                        isPropagationStopped(): boolean;
                                                                                                                                                                                                                                                                        preventDefault(): any;
                                                                                                                                                                                                                                                                        stopImmediatePropagation(): void;
                                                                                                                                                                                                                                                                        stopPropagation(): void;
                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    AT_TARGET +bubbles +BUBBLING_PHASE +cancelable +cancelBubble +CAPTURING_PHASE +composed +currentTarget +data +defaultPrevented +delegateTarget +eventPhase +isTrusted +metaKey +namespace +NONE +originalEvent +pageX +pageY +relatedTarget +result +returnValue +srcElement +target +timeStamp +type +which +

                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                    composedPath +initEvent +isDefaultPrevented +isImmediatePropagationStopped +isPropagationStopped +preventDefault +stopImmediatePropagation +stopPropagation +

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    AT_TARGET: 2
                                                                                                                                                                                                                                                                    bubbles: boolean

                                                                                                                                                                                                                                                                    Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    MDN Reference

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    BUBBLING_PHASE: 3
                                                                                                                                                                                                                                                                    cancelable: boolean

                                                                                                                                                                                                                                                                    Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    MDN Reference

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    cancelBubble: boolean

                                                                                                                                                                                                                                                                    MDN Reference

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    CAPTURING_PHASE: 1
                                                                                                                                                                                                                                                                    composed: boolean

                                                                                                                                                                                                                                                                    Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    MDN Reference

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    currentTarget: Element

                                                                                                                                                                                                                                                                    The current DOM element within the event bubbling phase.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    <a href="https://api.jquery.com/event.currentTarget/">https://api.jquery.com/event.currentTarget/</a>

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    data: any

                                                                                                                                                                                                                                                                    An optional object of data passed to an event method when the current executing handler is bound.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    <a href="https://api.jquery.com/event.data/">https://api.jquery.com/event.data/</a>

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    defaultPrevented: boolean

                                                                                                                                                                                                                                                                    Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    MDN Reference

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    delegateTarget: Element

                                                                                                                                                                                                                                                                    The element where the currently-called jQuery event handler was attached.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    <a href="https://api.jquery.com/event.delegateTarget/">https://api.jquery.com/event.delegateTarget/</a>

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    eventPhase: number

                                                                                                                                                                                                                                                                    Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    MDN Reference

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    isTrusted: boolean

                                                                                                                                                                                                                                                                    Returns true if event was dispatched by the user agent, and false otherwise.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    MDN Reference

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    metaKey: boolean

                                                                                                                                                                                                                                                                    Indicates whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    <a href="https://api.jquery.com/event.metaKey/">https://api.jquery.com/event.metaKey/</a>

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    namespace: string

                                                                                                                                                                                                                                                                    The namespace specified when the event was triggered.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    <a href="https://api.jquery.com/event.namespace/">https://api.jquery.com/event.namespace/</a>

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    NONE: 0
                                                                                                                                                                                                                                                                    originalEvent: Event

                                                                                                                                                                                                                                                                    The browser's original Event object.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    <a href="https://api.jquery.com/category/events/event-object/">https://api.jquery.com/category/events/event-object/</a>

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    pageX: number

                                                                                                                                                                                                                                                                    The mouse position relative to the left edge of the document.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    <a href="https://api.jquery.com/event.pageX/">https://api.jquery.com/event.pageX/</a>

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    pageY: number

                                                                                                                                                                                                                                                                    The mouse position relative to the top edge of the document.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    <a href="https://api.jquery.com/event.pageY/">https://api.jquery.com/event.pageY/</a>

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    relatedTarget: Element

                                                                                                                                                                                                                                                                    The other DOM element involved in the event, if any.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    <a href="https://api.jquery.com/event.relatedTarget/">https://api.jquery.com/event.relatedTarget/</a>

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    result: any

                                                                                                                                                                                                                                                                    The last value returned by an event handler that was triggered by this event, unless the value was undefined.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    <a href="https://api.jquery.com/event.result/">https://api.jquery.com/event.result/</a>

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    returnValue: boolean

                                                                                                                                                                                                                                                                    MDN Reference

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    srcElement: null | EventTarget

                                                                                                                                                                                                                                                                    MDN Reference

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    target: Element

                                                                                                                                                                                                                                                                    The DOM element that initiated the event.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    <a href="https://api.jquery.com/event.target/">https://api.jquery.com/event.target/</a>

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    timeStamp: number

                                                                                                                                                                                                                                                                    Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    MDN Reference

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    type: string

                                                                                                                                                                                                                                                                    Returns the type of event, e.g. "click", "hashchange", or "submit".

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    MDN Reference

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    which: number

                                                                                                                                                                                                                                                                    For key or mouse events, this property indicates the specific key or button that was pressed.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    <a href="https://api.jquery.com/event.which/">https://api.jquery.com/event.which/</a>

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                    • Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      MDN Reference

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Returns EventTarget[]

                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                      • type: string
                                                                                                                                                                                                                                                                      • Optionalbubbles: boolean
                                                                                                                                                                                                                                                                      • Optionalcancelable: boolean

                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                      MDN Reference

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                    • Returns whether event.preventDefault() was ever called on this event object.

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.isDefaultPrevented/">https://api.jquery.com/event.isDefaultPrevented/</a>

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                    • Returns whether event.stopImmediatePropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.isImmediatePropagationStopped/">https://api.jquery.com/event.isImmediatePropagationStopped/</a>

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                    • Returns whether event.stopPropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.isPropagationStopped/">https://api.jquery.com/event.isPropagationStopped/</a>

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                    • If this method is called, the default action of the event will not be triggered.

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.preventDefault/">https://api.jquery.com/event.preventDefault/</a>

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                    • Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.stopImmediatePropagation/">https://api.jquery.com/event.stopImmediatePropagation/</a>

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                    • Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.stopPropagation/">https://api.jquery.com/event.stopPropagation/</a>

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CKEvent.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.CKEvent.html new file mode 100644 index 000000000..72456749a --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.CKEvent.html @@ -0,0 +1,2 @@ +CKEvent | trilium
                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                      Interface CKEvent

                                                                                                                                                                                                                                                                      interface CKEvent {
                                                                                                                                                                                                                                                                          stop(): void;
                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                      stop +

                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CKNode.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.CKNode.html new file mode 100644 index 000000000..2f65f4447 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.CKNode.html @@ -0,0 +1,12 @@ +CKNode | trilium
                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                        Interface CKNode

                                                                                                                                                                                                                                                                        interface CKNode {
                                                                                                                                                                                                                                                                            _children: CKNode[];
                                                                                                                                                                                                                                                                            childCount: number;
                                                                                                                                                                                                                                                                            data: string;
                                                                                                                                                                                                                                                                            isEmpty: boolean;
                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                            root: {
                                                                                                                                                                                                                                                                                document: {
                                                                                                                                                                                                                                                                                    model: {
                                                                                                                                                                                                                                                                                        markers: { getMarkersIntersectingRange(range: TextRange): Marker[] };
                                                                                                                                                                                                                                                                                        createRangeIn(el: CKNode): TextRange;
                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                            startOffset: number;
                                                                                                                                                                                                                                                                            getAttribute(name: string): string;
                                                                                                                                                                                                                                                                            getChild(index: number): CKNode;
                                                                                                                                                                                                                                                                            is(type: string, name?: string): any;
                                                                                                                                                                                                                                                                            toJSON(): object;
                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        _children +childCount +data +isEmpty +name +root +startOffset +

                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                        getAttribute +getChild +is +toJSON +

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        _children

                                                                                                                                                                                                                                                                        _children: CKNode[]
                                                                                                                                                                                                                                                                        childCount: number
                                                                                                                                                                                                                                                                        data: string
                                                                                                                                                                                                                                                                        isEmpty: boolean
                                                                                                                                                                                                                                                                        name: string
                                                                                                                                                                                                                                                                        root: {
                                                                                                                                                                                                                                                                            document: {
                                                                                                                                                                                                                                                                                model: {
                                                                                                                                                                                                                                                                                    markers: { getMarkersIntersectingRange(range: TextRange): Marker[] };
                                                                                                                                                                                                                                                                                    createRangeIn(el: CKNode): TextRange;
                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                        startOffset: number

                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CodeMirrorInstance.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.CodeMirrorInstance.html new file mode 100644 index 000000000..91d964ff5 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.CodeMirrorInstance.html @@ -0,0 +1,15 @@ +CodeMirrorInstance | trilium
                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                          Interface CodeMirrorInstance

                                                                                                                                                                                                                                                                          interface CodeMirrorInstance {
                                                                                                                                                                                                                                                                              doc: {
                                                                                                                                                                                                                                                                                  getValue(): string;
                                                                                                                                                                                                                                                                                  markText(
                                                                                                                                                                                                                                                                                      from: number | { ch: number; line: number },
                                                                                                                                                                                                                                                                                      to: number | { ch: number; line: number },
                                                                                                                                                                                                                                                                                      opts: { className: string },
                                                                                                                                                                                                                                                                                  ): any;
                                                                                                                                                                                                                                                                                  replaceRange(text: string, from: number, to: number): any;
                                                                                                                                                                                                                                                                                  setSelection(from: number, to: number): any;
                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                              clearHistory(): any;
                                                                                                                                                                                                                                                                              focus(): any;
                                                                                                                                                                                                                                                                              getCursor(): { ch: number; col: number; line: number };
                                                                                                                                                                                                                                                                              getSelection(): string;
                                                                                                                                                                                                                                                                              getValue(): string;
                                                                                                                                                                                                                                                                              lineCount(): number;
                                                                                                                                                                                                                                                                              on(event: string, callback: () => void): any;
                                                                                                                                                                                                                                                                              operation(callback: () => void): any;
                                                                                                                                                                                                                                                                              refresh(): any;
                                                                                                                                                                                                                                                                              scrollIntoView(pos: number): any;
                                                                                                                                                                                                                                                                              setCursor(line: number, col: number): any;
                                                                                                                                                                                                                                                                              setOption(name: string, value: string): any;
                                                                                                                                                                                                                                                                              setValue(val: string): any;
                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          doc +

                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                          clearHistory +focus +getCursor +getSelection +getValue +lineCount +on +operation +refresh +scrollIntoView +setCursor +setOption +setValue +

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          doc: {
                                                                                                                                                                                                                                                                              getValue(): string;
                                                                                                                                                                                                                                                                              markText(
                                                                                                                                                                                                                                                                                  from: number | { ch: number; line: number },
                                                                                                                                                                                                                                                                                  to: number | { ch: number; line: number },
                                                                                                                                                                                                                                                                                  opts: { className: string },
                                                                                                                                                                                                                                                                              ): any;
                                                                                                                                                                                                                                                                              replaceRange(text: string, from: number, to: number): any;
                                                                                                                                                                                                                                                                              setSelection(from: number, to: number): any;
                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CommandData.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.CommandData.html new file mode 100644 index 000000000..ae5ae67b7 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.CommandData.html @@ -0,0 +1,3 @@ +CommandData | trilium
                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                            Interface CommandData

                                                                                                                                                                                                                                                                            Base interface for the data/arguments for a given command (see CommandMappings).

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            interface CommandData {
                                                                                                                                                                                                                                                                                ntxId?: null | string;
                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                            ntxId? +

                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                            ntxId?: null | string

                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmDialogOptions.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmDialogOptions.html new file mode 100644 index 000000000..7c686c74c --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmDialogOptions.html @@ -0,0 +1,3 @@ +ConfirmDialogOptions | trilium
                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                              Interface ConfirmDialogOptions

                                                                                                                                                                                                                                                                              interface ConfirmDialogOptions {
                                                                                                                                                                                                                                                                                  confirmed: boolean;
                                                                                                                                                                                                                                                                                  isDeleteNoteChecked: boolean;
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              confirmed +isDeleteNoteChecked +

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              confirmed: boolean
                                                                                                                                                                                                                                                                              isDeleteNoteChecked: boolean

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmWithMessageOptions.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmWithMessageOptions.html new file mode 100644 index 000000000..97455649a --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmWithMessageOptions.html @@ -0,0 +1,3 @@ +ConfirmWithMessageOptions | trilium
                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                Interface ConfirmWithMessageOptions

                                                                                                                                                                                                                                                                                interface ConfirmWithMessageOptions {
                                                                                                                                                                                                                                                                                    callback: ConfirmDialogCallback;
                                                                                                                                                                                                                                                                                    message: string | HTMLElement | JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                callback +message +

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                callback: ConfirmDialogCallback
                                                                                                                                                                                                                                                                                message: string | HTMLElement | JQuery<HTMLElement>

                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmWithTitleOptions.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmWithTitleOptions.html new file mode 100644 index 000000000..4a1adee68 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ConfirmWithTitleOptions.html @@ -0,0 +1,3 @@ +ConfirmWithTitleOptions | trilium
                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                  Interface ConfirmWithTitleOptions

                                                                                                                                                                                                                                                                                  interface ConfirmWithTitleOptions {
                                                                                                                                                                                                                                                                                      callback: ConfirmDialogCallback;
                                                                                                                                                                                                                                                                                      title: string;
                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  callback +title +

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  callback: ConfirmDialogCallback
                                                                                                                                                                                                                                                                                  title: string

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ContextMenuCommandData.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ContextMenuCommandData.html new file mode 100644 index 000000000..2cd0ceed5 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ContextMenuCommandData.html @@ -0,0 +1,8 @@ +ContextMenuCommandData | trilium
                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                    Interface ContextMenuCommandData

                                                                                                                                                                                                                                                                                    Represents a set of commands that are triggered from the context menu, providing information such as the selected note.

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    interface ContextMenuCommandData {
                                                                                                                                                                                                                                                                                        node: FancytreeNode;
                                                                                                                                                                                                                                                                                        noteId?: string;
                                                                                                                                                                                                                                                                                        notePath?: string;
                                                                                                                                                                                                                                                                                        ntxId?: null | string;
                                                                                                                                                                                                                                                                                        selectedOrActiveBranchIds?: any;
                                                                                                                                                                                                                                                                                        selectedOrActiveNoteIds: any;
                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    node +noteId? +notePath? +ntxId? +selectedOrActiveBranchIds? +selectedOrActiveNoteIds +

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    node: FancytreeNode
                                                                                                                                                                                                                                                                                    noteId?: string
                                                                                                                                                                                                                                                                                    notePath?: string
                                                                                                                                                                                                                                                                                    ntxId?: null | string
                                                                                                                                                                                                                                                                                    selectedOrActiveBranchIds?: any
                                                                                                                                                                                                                                                                                    selectedOrActiveNoteIds: any

                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.CreateLinkOptions.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.CreateLinkOptions.html new file mode 100644 index 000000000..6a9040241 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.CreateLinkOptions.html @@ -0,0 +1,8 @@ +CreateLinkOptions | trilium
                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                      Interface CreateLinkOptions

                                                                                                                                                                                                                                                                                      interface CreateLinkOptions {
                                                                                                                                                                                                                                                                                          autoConvertToImage?: boolean;
                                                                                                                                                                                                                                                                                          referenceLink?: boolean;
                                                                                                                                                                                                                                                                                          showNoteIcon?: boolean;
                                                                                                                                                                                                                                                                                          showNotePath?: boolean;
                                                                                                                                                                                                                                                                                          showTooltip?: boolean;
                                                                                                                                                                                                                                                                                          title?: string;
                                                                                                                                                                                                                                                                                          viewScope?: ViewScope;
                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      autoConvertToImage? +referenceLink? +showNoteIcon? +showNotePath? +showTooltip? +title? +viewScope? +

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      autoConvertToImage?: boolean
                                                                                                                                                                                                                                                                                      referenceLink?: boolean
                                                                                                                                                                                                                                                                                      showNoteIcon?: boolean
                                                                                                                                                                                                                                                                                      showNotePath?: boolean
                                                                                                                                                                                                                                                                                      showTooltip?: boolean
                                                                                                                                                                                                                                                                                      title?: string
                                                                                                                                                                                                                                                                                      viewScope?: ViewScope

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.DefinitionObject.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.DefinitionObject.html new file mode 100644 index 000000000..e06f9317c --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.DefinitionObject.html @@ -0,0 +1,7 @@ +DefinitionObject | trilium
                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                        Interface DefinitionObject

                                                                                                                                                                                                                                                                                        interface DefinitionObject {
                                                                                                                                                                                                                                                                                            inverseRelation?: string;
                                                                                                                                                                                                                                                                                            isPromoted?: boolean;
                                                                                                                                                                                                                                                                                            labelType?: LabelType;
                                                                                                                                                                                                                                                                                            multiplicity?: Multiplicity;
                                                                                                                                                                                                                                                                                            numberPrecision?: number;
                                                                                                                                                                                                                                                                                            promotedAlias?: string;
                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        inverseRelation? +isPromoted? +labelType? +multiplicity? +numberPrecision? +promotedAlias? +

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        inverseRelation?: string
                                                                                                                                                                                                                                                                                        isPromoted?: boolean
                                                                                                                                                                                                                                                                                        labelType?: LabelType
                                                                                                                                                                                                                                                                                        multiplicity?: Multiplicity
                                                                                                                                                                                                                                                                                        numberPrecision?: number
                                                                                                                                                                                                                                                                                        promotedAlias?: string

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.DragAndDrop5.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.DragAndDrop5.html new file mode 100644 index 000000000..34eae1f91 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.DragAndDrop5.html @@ -0,0 +1,39 @@ +DragAndDrop5 | trilium
                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                          Interface DragAndDrop5

                                                                                                                                                                                                                                                                                          interface DragAndDrop5 {
                                                                                                                                                                                                                                                                                              autoExpandMS?: number;
                                                                                                                                                                                                                                                                                              dragDrag?: (sourceNode: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                                                                                              dragDrop?: (node: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                                                                                              dragEnd?: (sourceNode: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                                                                                              dragEnter?: (targetNode: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                                                                                              dragExpand?: (targetNode: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                                                                                              dragLeave?: (targetNode: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                                                                                              dragOver?: (targetNode: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                                                                                              dragStart?: (sourceNode: FancytreeNode, data: any) => void;
                                                                                                                                                                                                                                                                                              dropMarkerInsertOffsetX?: number;
                                                                                                                                                                                                                                                                                              dropMarkerOffsetX?: number;
                                                                                                                                                                                                                                                                                              multiSource?: boolean;
                                                                                                                                                                                                                                                                                              preventForeignNodes?: boolean;
                                                                                                                                                                                                                                                                                              preventNonNodes?: boolean;
                                                                                                                                                                                                                                                                                              preventRecursiveMoves?: boolean;
                                                                                                                                                                                                                                                                                              preventVoidMoves?: boolean;
                                                                                                                                                                                                                                                                                              scroll?: boolean;
                                                                                                                                                                                                                                                                                              scrollSensitivity?: number;
                                                                                                                                                                                                                                                                                              scrollSpeed?: number;
                                                                                                                                                                                                                                                                                              setTextTypeJson?: boolean;
                                                                                                                                                                                                                                                                                              [key: string]: any;
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                          • [key: string]: any

                                                                                                                                                                                                                                                                                            Support misc options

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          autoExpandMS? +dragDrag? +dragDrop? +dragEnd? +dragEnter? +dragExpand? +dragLeave? +dragOver? +dragStart? +dropMarkerInsertOffsetX? +dropMarkerOffsetX? +multiSource? +preventForeignNodes? +preventNonNodes? +preventRecursiveMoves? +preventVoidMoves? +scroll? +scrollSensitivity? +scrollSpeed? +setTextTypeJson? +

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          autoExpandMS?: number

                                                                                                                                                                                                                                                                                          Expand nodes after n milliseconds of hovering.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          dragDrag?: (sourceNode: FancytreeNode, data: any) => void
                                                                                                                                                                                                                                                                                          dragDrop?: (node: FancytreeNode, data: any) => void

                                                                                                                                                                                                                                                                                          Events (drag drop)

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          dragEnd?: (sourceNode: FancytreeNode, data: any) => void
                                                                                                                                                                                                                                                                                          dragEnter?: (targetNode: FancytreeNode, data: any) => void

                                                                                                                                                                                                                                                                                          Callback(targetNode, data), return true, to enable dnd drop

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          dragExpand?: (targetNode: FancytreeNode, data: any) => void

                                                                                                                                                                                                                                                                                          Callback(targetNode, data), return false to prevent autoExpand

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          dragLeave?: (targetNode: FancytreeNode, data: any) => void
                                                                                                                                                                                                                                                                                          dragOver?: (targetNode: FancytreeNode, data: any) => void

                                                                                                                                                                                                                                                                                          Events (drag over)

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          dragStart?: (sourceNode: FancytreeNode, data: any) => void

                                                                                                                                                                                                                                                                                          Callback(sourceNode, data), return true, to enable dnd drag

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          dropMarkerInsertOffsetX?: number

                                                                                                                                                                                                                                                                                          Additional offset for drop-marker with hitMode = "before"/"after"

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          dropMarkerOffsetX?: number

                                                                                                                                                                                                                                                                                          Absolute position offset for .fancytree-drop-marker

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          multiSource?: boolean

                                                                                                                                                                                                                                                                                          true: Drag multiple (i.e. selected) nodes.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          preventForeignNodes?: boolean

                                                                                                                                                                                                                                                                                          Prevent dropping nodes from different Fancytrees

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          preventNonNodes?: boolean

                                                                                                                                                                                                                                                                                          Prevent dropping items other than Fancytree nodes

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          preventRecursiveMoves?: boolean

                                                                                                                                                                                                                                                                                          Prevent dropping nodes on own descendants

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          preventVoidMoves?: boolean

                                                                                                                                                                                                                                                                                          Prevent dropping nodes 'before self', etc.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          scroll?: boolean

                                                                                                                                                                                                                                                                                          Enable auto-scrolling while dragging

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          scrollSensitivity?: number

                                                                                                                                                                                                                                                                                          Active top/bottom margin in pixel

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          scrollSpeed?: number

                                                                                                                                                                                                                                                                                          Pixel per event

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          setTextTypeJson?: boolean

                                                                                                                                                                                                                                                                                          Allow dragging of nodes to different IE windows, default: false

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Event.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Event.html new file mode 100644 index 000000000..c0bb69d4c --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Event.html @@ -0,0 +1,141 @@ +Event | trilium
                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                            Interface Event

                                                                                                                                                                                                                                                                                            jQuery's event system normalizes the event object according to W3C standards. The event object is guaranteed to be passed to the event handler (no checks for window.event required). It normalizes the target, relatedTarget, which, metaKey and pageX/Y properties and provides both stopPropagation() and preventDefault() methods.

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Those properties are all documented, and accompanied by examples, on the <a href="http://api.jquery.com/category/events/event-object/">Event object</a> page.

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            The standard events in the Document Object Model are: blur, focus, load, resize, scroll, unload, beforeunload, click, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, and keyup. Since the DOM event names have predefined meanings for some elements, using them for other purposes is not recommended. jQuery's event model can trigger an event by any name on an element, and it is propagated up the DOM tree to which that element belongs, if any.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                            • <a href="https://api.jquery.com/category/events/event-object/">https://api.jquery.com/category/events/event-object/</a>
                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                            • <a href="Frontend_Script_API._internal_.TriggeredEvent.html" class="tsd-kind-interface">TriggeredEvent</a>
                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            interface Event {
                                                                                                                                                                                                                                                                                                altKey: undefined | boolean;
                                                                                                                                                                                                                                                                                                bubbles: undefined | boolean;
                                                                                                                                                                                                                                                                                                button: undefined | number;
                                                                                                                                                                                                                                                                                                buttons: undefined | number;
                                                                                                                                                                                                                                                                                                cancelable: undefined | boolean;
                                                                                                                                                                                                                                                                                                changedTouches: undefined | TouchList;
                                                                                                                                                                                                                                                                                                char: undefined | string;
                                                                                                                                                                                                                                                                                                charCode: undefined | number;
                                                                                                                                                                                                                                                                                                clientX: undefined | number;
                                                                                                                                                                                                                                                                                                clientY: undefined | number;
                                                                                                                                                                                                                                                                                                ctrlKey: undefined | boolean;
                                                                                                                                                                                                                                                                                                detail: undefined | number;
                                                                                                                                                                                                                                                                                                eventPhase: undefined | number;
                                                                                                                                                                                                                                                                                                key: undefined | string;
                                                                                                                                                                                                                                                                                                keyCode: undefined | number;
                                                                                                                                                                                                                                                                                                metaKey: undefined | boolean;
                                                                                                                                                                                                                                                                                                offsetX: undefined | number;
                                                                                                                                                                                                                                                                                                offsetY: undefined | number;
                                                                                                                                                                                                                                                                                                pageX: undefined | number;
                                                                                                                                                                                                                                                                                                pageY: undefined | number;
                                                                                                                                                                                                                                                                                                pointerId: undefined | number;
                                                                                                                                                                                                                                                                                                pointerType: undefined | string;
                                                                                                                                                                                                                                                                                                screenX: undefined | number;
                                                                                                                                                                                                                                                                                                screenY: undefined | number;
                                                                                                                                                                                                                                                                                                shiftKey: undefined | boolean;
                                                                                                                                                                                                                                                                                                targetTouches: undefined | TouchList;
                                                                                                                                                                                                                                                                                                timeStamp: number;
                                                                                                                                                                                                                                                                                                toElement: undefined | Element;
                                                                                                                                                                                                                                                                                                touches: undefined | TouchList;
                                                                                                                                                                                                                                                                                                type: string;
                                                                                                                                                                                                                                                                                                view: undefined | Window;
                                                                                                                                                                                                                                                                                                which: undefined | number;
                                                                                                                                                                                                                                                                                                isDefaultPrevented(): boolean;
                                                                                                                                                                                                                                                                                                isImmediatePropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                isPropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                preventDefault(): void;
                                                                                                                                                                                                                                                                                                stopImmediatePropagation(): void;
                                                                                                                                                                                                                                                                                                stopPropagation(): void;
                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                            altKey +bubbles +button +buttons +cancelable +changedTouches +char +charCode +clientX +clientY +ctrlKey +detail +eventPhase +key +keyCode +metaKey +offsetX +offsetY +pageX +pageY +pointerId +pointerType +screenX +screenY +shiftKey +targetTouches +timeStamp +toElement +touches +type +view +which +

                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                            isDefaultPrevented +isImmediatePropagationStopped +isPropagationStopped +preventDefault +stopImmediatePropagation +stopPropagation +

                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                            altKey: undefined | boolean
                                                                                                                                                                                                                                                                                            bubbles: undefined | boolean
                                                                                                                                                                                                                                                                                            button: undefined | number
                                                                                                                                                                                                                                                                                            buttons: undefined | number
                                                                                                                                                                                                                                                                                            cancelable: undefined | boolean
                                                                                                                                                                                                                                                                                            changedTouches: undefined | TouchList
                                                                                                                                                                                                                                                                                            char: undefined | string
                                                                                                                                                                                                                                                                                            charCode: undefined | number
                                                                                                                                                                                                                                                                                            clientX: undefined | number
                                                                                                                                                                                                                                                                                            clientY: undefined | number
                                                                                                                                                                                                                                                                                            ctrlKey: undefined | boolean
                                                                                                                                                                                                                                                                                            detail: undefined | number
                                                                                                                                                                                                                                                                                            eventPhase: undefined | number
                                                                                                                                                                                                                                                                                            key: undefined | string
                                                                                                                                                                                                                                                                                            keyCode: undefined | number
                                                                                                                                                                                                                                                                                            metaKey: undefined | boolean

                                                                                                                                                                                                                                                                                            Indicates whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.metaKey/">https://api.jquery.com/event.metaKey/</a>

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            1.0.4

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Example: ​ ````Determine whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                                            <!doctype html>
                                                                                                                                                                                                                                                                                            <html lang="en">
                                                                                                                                                                                                                                                                                            <head>
                                                                                                                                                                                                                                                                                            <meta charset="utf-8">
                                                                                                                                                                                                                                                                                            <title>event.metaKey demo</title>
                                                                                                                                                                                                                                                                                            <style>
                                                                                                                                                                                                                                                                                            body {
                                                                                                                                                                                                                                                                                            background-color: #eef;
                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                            div {
                                                                                                                                                                                                                                                                                            padding: 20px;
                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                            </style>
                                                                                                                                                                                                                                                                                            <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                            </head>
                                                                                                                                                                                                                                                                                            <body>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            <button value="Test" name="Test" id="checkMetaKey">Click me!</button>
                                                                                                                                                                                                                                                                                            <div id="display"></div>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            <script>
                                                                                                                                                                                                                                                                                            $( "#checkMetaKey" ).click(function( event ) {
                                                                                                                                                                                                                                                                                            $( "#display" ).text( event.metaKey );
                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                            </script>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            </body>
                                                                                                                                                                                                                                                                                            </html>
+
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            offsetX: undefined | number
                                                                                                                                                                                                                                                                                            offsetY: undefined | number
                                                                                                                                                                                                                                                                                            pageX: undefined | number

                                                                                                                                                                                                                                                                                            The mouse position relative to the left edge of the document.

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.pageX/">https://api.jquery.com/event.pageX/</a>

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            1.0.4

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Example: ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe).

                                                                                                                                                                                                                                                                                            <!doctype html>
                                                                                                                                                                                                                                                                                            <html lang="en">
                                                                                                                                                                                                                                                                                            <head>
                                                                                                                                                                                                                                                                                            <meta charset="utf-8">
                                                                                                                                                                                                                                                                                            <title>event.pageX demo</title>
                                                                                                                                                                                                                                                                                            <style>
                                                                                                                                                                                                                                                                                            body {
                                                                                                                                                                                                                                                                                            background-color: #eef;
                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                            div {
                                                                                                                                                                                                                                                                                            padding: 20px;
                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                            </style>
                                                                                                                                                                                                                                                                                            <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                            </head>
                                                                                                                                                                                                                                                                                            <body>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            <div id="log"></div>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            <script>
                                                                                                                                                                                                                                                                                            $( document ).on( "mousemove", function( event ) {
                                                                                                                                                                                                                                                                                            $( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                            </script>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            </body>
                                                                                                                                                                                                                                                                                            </html>
+
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            pageY: undefined | number

                                                                                                                                                                                                                                                                                            The mouse position relative to the top edge of the document.

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.pageY/">https://api.jquery.com/event.pageY/</a>

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            1.0.4

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Example: ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe).

                                                                                                                                                                                                                                                                                            <!doctype html>
                                                                                                                                                                                                                                                                                            <html lang="en">
                                                                                                                                                                                                                                                                                            <head>
                                                                                                                                                                                                                                                                                            <meta charset="utf-8">
                                                                                                                                                                                                                                                                                            <title>event.pageY demo</title>
                                                                                                                                                                                                                                                                                            <style>
                                                                                                                                                                                                                                                                                            body {
                                                                                                                                                                                                                                                                                            background-color: #eef;
                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                            div {
                                                                                                                                                                                                                                                                                            padding: 20px;
                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                            </style>
                                                                                                                                                                                                                                                                                            <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                            </head>
                                                                                                                                                                                                                                                                                            <body>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            <div id="log"></div>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            <script>
                                                                                                                                                                                                                                                                                            $( document ).on( "mousemove", function( event ) {
                                                                                                                                                                                                                                                                                            $( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                            </script>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            </body>
                                                                                                                                                                                                                                                                                            </html>
+
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            pointerId: undefined | number
                                                                                                                                                                                                                                                                                            pointerType: undefined | string
                                                                                                                                                                                                                                                                                            screenX: undefined | number
                                                                                                                                                                                                                                                                                            screenY: undefined | number
                                                                                                                                                                                                                                                                                            shiftKey: undefined | boolean
                                                                                                                                                                                                                                                                                            targetTouches: undefined | TouchList
                                                                                                                                                                                                                                                                                            timeStamp: number

                                                                                                                                                                                                                                                                                            The difference in milliseconds between the time the browser created the event and January 1, 1970.

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.timeStamp/">https://api.jquery.com/event.timeStamp/</a>

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            1.2.6

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Example: ​ ````Display the time since the click handler last executed.

                                                                                                                                                                                                                                                                                            <!doctype html>
                                                                                                                                                                                                                                                                                            <html lang="en">
                                                                                                                                                                                                                                                                                            <head>
                                                                                                                                                                                                                                                                                            <meta charset="utf-8">
                                                                                                                                                                                                                                                                                            <title>event.timeStamp demo</title>
                                                                                                                                                                                                                                                                                            <style>
                                                                                                                                                                                                                                                                                            div {
                                                                                                                                                                                                                                                                                            height: 100px;
                                                                                                                                                                                                                                                                                            width: 300px;
                                                                                                                                                                                                                                                                                            margin: 10px;
                                                                                                                                                                                                                                                                                            background-color: #ffd;
                                                                                                                                                                                                                                                                                            overflow: auto;
                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                            </style>
                                                                                                                                                                                                                                                                                            <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                            </head>
                                                                                                                                                                                                                                                                                            <body>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            <div>Click.</div>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            <script>
                                                                                                                                                                                                                                                                                            var last, diff;
                                                                                                                                                                                                                                                                                            $( "div" ).click(function( event ) {
                                                                                                                                                                                                                                                                                            if ( last ) {
                                                                                                                                                                                                                                                                                            diff = event.timeStamp - last;
                                                                                                                                                                                                                                                                                            $( "div" ).append( "time since last event: " + diff + "<br>" );
                                                                                                                                                                                                                                                                                            } else {
                                                                                                                                                                                                                                                                                            $( "div" ).append( "Click again.<br>" );
                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                            last = event.timeStamp;
                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                            </script>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            </body>
                                                                                                                                                                                                                                                                                            </html>
+
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            toElement: undefined | Element
                                                                                                                                                                                                                                                                                            touches: undefined | TouchList
                                                                                                                                                                                                                                                                                            type: string

                                                                                                                                                                                                                                                                                            Describes the nature of the event.

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.type/">https://api.jquery.com/event.type/</a>

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            1.0

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Example: ​ ````On all anchor clicks, alert the event type.

                                                                                                                                                                                                                                                                                            $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                            alert( event.type ); // "click"
                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            view: undefined | Window
                                                                                                                                                                                                                                                                                            which: undefined | number

                                                                                                                                                                                                                                                                                            For key or mouse events, this property indicates the specific key or button that was pressed.

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.which/">https://api.jquery.com/event.which/</a>

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            1.1.3

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Example: ​ ````Log which key was depressed. +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>event.which demo</title> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<input id="whichkey" value="type something"> +<div id="log"></div> +​ +<script> +$( "#whichkey" ).on( "keydown", function( event ) { +$( "#log" ).html( event.type + ": " + event.which ); +}); +</script> +​ +</body> +</html> +``` +@example ​ ````Log which mouse button was depressed.

                                                                                                                                                                                                                                                                                            <!doctype html>
                                                                                                                                                                                                                                                                                            <html lang="en">
                                                                                                                                                                                                                                                                                            <head>
                                                                                                                                                                                                                                                                                            <meta charset="utf-8">
                                                                                                                                                                                                                                                                                            <title>event.which demo</title>
                                                                                                                                                                                                                                                                                            <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                            </head>
                                                                                                                                                                                                                                                                                            <body>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            <input id="whichkey" value="click here">
                                                                                                                                                                                                                                                                                            <div id="log"></div>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            <script>
                                                                                                                                                                                                                                                                                            $( "#whichkey" ).on( "mousedown", function( event ) {
                                                                                                                                                                                                                                                                                            $( "#log" ).html( event.type + ": " +  event.which );
                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                            </script>
                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                            </body>
                                                                                                                                                                                                                                                                                            </html>
+
                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                            • Returns whether event.preventDefault() was ever called on this event object.

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/event.isDefaultPrevented/">https://api.jquery.com/event.isDefaultPrevented/</a>

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              1.3

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Example: ​ ````Checks whether event.preventDefault() was called.

                                                                                                                                                                                                                                                                                              $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                              alert( event.isDefaultPrevented() ); // false
                                                                                                                                                                                                                                                                                              event.preventDefault();
                                                                                                                                                                                                                                                                                              alert( event.isDefaultPrevented() ); // true
                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                            • Returns whether event.stopImmediatePropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/event.isImmediatePropagationStopped/">https://api.jquery.com/event.isImmediatePropagationStopped/</a>

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              1.3

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Example: ​ ````Checks whether event.stopImmediatePropagation() was called.

                                                                                                                                                                                                                                                                                              <!doctype html>
                                                                                                                                                                                                                                                                                              <html lang="en">
                                                                                                                                                                                                                                                                                              <head>
                                                                                                                                                                                                                                                                                              <meta charset="utf-8">
                                                                                                                                                                                                                                                                                              <title>event.isImmediatePropagationStopped demo</title>
                                                                                                                                                                                                                                                                                              <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                              </head>
                                                                                                                                                                                                                                                                                              <body>
                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                              <button>click me</button>
                                                                                                                                                                                                                                                                                              <div id="stop-log"></div>
                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                              <script>
                                                                                                                                                                                                                                                                                              function immediatePropStopped( event ) {
                                                                                                                                                                                                                                                                                              var msg = "";
                                                                                                                                                                                                                                                                                              if ( event.isImmediatePropagationStopped() ) {
                                                                                                                                                                                                                                                                                              msg = "called";
                                                                                                                                                                                                                                                                                              } else {
                                                                                                                                                                                                                                                                                              msg = "not called";
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              $( "#stop-log" ).append( "<div>" + msg + "</div>" );
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                              $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                              immediatePropStopped( event );
                                                                                                                                                                                                                                                                                              event.stopImmediatePropagation();
                                                                                                                                                                                                                                                                                              immediatePropStopped( event );
                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                              </script>
                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                              </body>
                                                                                                                                                                                                                                                                                              </html>
+
                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                            • Returns whether event.stopPropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/event.isPropagationStopped/">https://api.jquery.com/event.isPropagationStopped/</a>

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              1.3

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Example: ​ ````Checks whether event.stopPropagation() was called

                                                                                                                                                                                                                                                                                              <!doctype html>
                                                                                                                                                                                                                                                                                              <html lang="en">
                                                                                                                                                                                                                                                                                              <head>
                                                                                                                                                                                                                                                                                              <meta charset="utf-8">
                                                                                                                                                                                                                                                                                              <title>event.isPropagationStopped demo</title>
                                                                                                                                                                                                                                                                                              <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                              </head>
                                                                                                                                                                                                                                                                                              <body>
                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                              <button>click me</button>
                                                                                                                                                                                                                                                                                              <div id="stop-log"></div>
                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                              <script>
                                                                                                                                                                                                                                                                                              function propStopped( event ) {
                                                                                                                                                                                                                                                                                              var msg = "";
                                                                                                                                                                                                                                                                                              if ( event.isPropagationStopped() ) {
                                                                                                                                                                                                                                                                                              msg = "called";
                                                                                                                                                                                                                                                                                              } else {
                                                                                                                                                                                                                                                                                              msg = "not called";
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              $( "#stop-log" ).append( "<div>" + msg + "</div>" );
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                              $( "button" ).click(function(event) {
                                                                                                                                                                                                                                                                                              propStopped( event );
                                                                                                                                                                                                                                                                                              event.stopPropagation();
                                                                                                                                                                                                                                                                                              propStopped( event );
                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                              </script>
                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                              </body>
                                                                                                                                                                                                                                                                                              </html>
+
                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                            • If this method is called, the default action of the event will not be triggered.

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/event.preventDefault/">https://api.jquery.com/event.preventDefault/</a>

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              1.0

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Example: ​ ````Cancel the default action (navigation) of the click.

                                                                                                                                                                                                                                                                                              <!doctype html>
                                                                                                                                                                                                                                                                                              <html lang="en">
                                                                                                                                                                                                                                                                                              <head>
                                                                                                                                                                                                                                                                                              <meta charset="utf-8">
                                                                                                                                                                                                                                                                                              <title>event.preventDefault demo</title>
                                                                                                                                                                                                                                                                                              <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                              </head>
                                                                                                                                                                                                                                                                                              <body>
                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                              <a href="https://jquery.com">default click action is prevented</a>
                                                                                                                                                                                                                                                                                              <div id="log"></div>
                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                              <script>
                                                                                                                                                                                                                                                                                              $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                              event.preventDefault();
                                                                                                                                                                                                                                                                                              $( "<div>" )
                                                                                                                                                                                                                                                                                              .append( "default " + event.type + " prevented" )
                                                                                                                                                                                                                                                                                              .appendTo( "#log" );
                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                              </script>
                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                              </body>
                                                                                                                                                                                                                                                                                              </html>
+
                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                            • Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/event.stopImmediatePropagation/">https://api.jquery.com/event.stopImmediatePropagation/</a>

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              1.3

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Example: ​ ````Prevents other event handlers from being called.

                                                                                                                                                                                                                                                                                              <!doctype html>
                                                                                                                                                                                                                                                                                              <html lang="en">
                                                                                                                                                                                                                                                                                              <head>
                                                                                                                                                                                                                                                                                              <meta charset="utf-8">
                                                                                                                                                                                                                                                                                              <title>event.stopImmediatePropagation demo</title>
                                                                                                                                                                                                                                                                                              <style>
                                                                                                                                                                                                                                                                                              p {
                                                                                                                                                                                                                                                                                              height: 30px;
                                                                                                                                                                                                                                                                                              width: 150px;
                                                                                                                                                                                                                                                                                              background-color: #ccf;
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              div {
                                                                                                                                                                                                                                                                                              height: 30px;
                                                                                                                                                                                                                                                                                              width: 150px;
                                                                                                                                                                                                                                                                                              background-color: #cfc;
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              </style>
                                                                                                                                                                                                                                                                                              <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                              </head>
                                                                                                                                                                                                                                                                                              <body>
                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                              <p>paragraph</p>
                                                                                                                                                                                                                                                                                              <div>division</div>
                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                              <script>
                                                                                                                                                                                                                                                                                              $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                              event.stopImmediatePropagation();
                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                              $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                              // This function won't be executed
                                                                                                                                                                                                                                                                                              $( this ).css( "background-color", "#f00" );
                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                              $( "div" ).click(function( event ) {
                                                                                                                                                                                                                                                                                              // This function will be executed
                                                                                                                                                                                                                                                                                              $( this ).css( "background-color", "#f00" );
                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                              </script>
                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                              </body>
                                                                                                                                                                                                                                                                                              </html>
+
                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                            • Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/event.stopPropagation/">https://api.jquery.com/event.stopPropagation/</a>

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              1.0

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Example: ​ ````Kill the bubbling on the click event.

                                                                                                                                                                                                                                                                                              $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                              event.stopPropagation();
                                                                                                                                                                                                                                                                                              // Do something
                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.EventData.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.EventData.html new file mode 100644 index 000000000..3d448a794 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.EventData.html @@ -0,0 +1,19 @@ +EventData | trilium
                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                              Interface EventData

                                                                                                                                                                                                                                                                                              Context object passed to events and hook functions.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              interface EventData {
                                                                                                                                                                                                                                                                                                  node: FancytreeNode;
                                                                                                                                                                                                                                                                                                  options: FancytreeOptions;
                                                                                                                                                                                                                                                                                                  originalEvent: JQueryEventObject;
                                                                                                                                                                                                                                                                                                  response: any;
                                                                                                                                                                                                                                                                                                  result: any;
                                                                                                                                                                                                                                                                                                  targetType: string;
                                                                                                                                                                                                                                                                                                  tree: Fancytree;
                                                                                                                                                                                                                                                                                                  widget: any;
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              node +options +originalEvent +response +result +targetType +tree +widget +

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              node: FancytreeNode

                                                                                                                                                                                                                                                                                              The node that this call applies to (null for tree events)

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              options: FancytreeOptions

                                                                                                                                                                                                                                                                                              Shortcut to tree.options

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              originalEvent: JQueryEventObject

                                                                                                                                                                                                                                                                                              The jQuery Event that initially triggered this call

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              response: any

                                                                                                                                                                                                                                                                                              (only for postProcess event) Original ajax response

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              result: any

                                                                                                                                                                                                                                                                                              (output parameter) Event handlers can return values back to the +caller. Used by lazyLoad, postProcess, ...

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              targetType: string

                                                                                                                                                                                                                                                                                              (only for click and dblclick events) 'title' | 'prefix' | 'expander' | 'checkbox' | 'icon'

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              tree: Fancytree

                                                                                                                                                                                                                                                                                              The tree instance

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              widget: any

                                                                                                                                                                                                                                                                                              The jQuery UI tree widget

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ExecuteCommandData.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ExecuteCommandData.html new file mode 100644 index 000000000..8524ddd29 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ExecuteCommandData.html @@ -0,0 +1,4 @@ +ExecuteCommandData | trilium
                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                Interface ExecuteCommandData<T>

                                                                                                                                                                                                                                                                                                Base interface for the data/arguments for a given command (see CommandMappings).

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                interface ExecuteCommandData<T> {
                                                                                                                                                                                                                                                                                                    ntxId?: null | string;
                                                                                                                                                                                                                                                                                                    resolve: (data: T) => void;
                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                ntxId? +resolve +

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                ntxId?: null | string
                                                                                                                                                                                                                                                                                                resolve: (data: T) => void

                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FAttachmentRow.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.FAttachmentRow.html new file mode 100644 index 000000000..407515b16 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.FAttachmentRow.html @@ -0,0 +1,10 @@ +FAttachmentRow | trilium
                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                  Interface FAttachmentRow

                                                                                                                                                                                                                                                                                                  interface FAttachmentRow {
                                                                                                                                                                                                                                                                                                      attachmentId: string;
                                                                                                                                                                                                                                                                                                      contentLength: number;
                                                                                                                                                                                                                                                                                                      dateModified: string;
                                                                                                                                                                                                                                                                                                      mime: string;
                                                                                                                                                                                                                                                                                                      ownerId: string;
                                                                                                                                                                                                                                                                                                      role: string;
                                                                                                                                                                                                                                                                                                      title: string;
                                                                                                                                                                                                                                                                                                      utcDateModified: string;
                                                                                                                                                                                                                                                                                                      utcDateScheduledForErasureSince: string;
                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  attachmentId +contentLength +dateModified +mime +ownerId +role +title +utcDateModified +utcDateScheduledForErasureSince +

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  attachmentId: string
                                                                                                                                                                                                                                                                                                  contentLength: number
                                                                                                                                                                                                                                                                                                  dateModified: string
                                                                                                                                                                                                                                                                                                  mime: string
                                                                                                                                                                                                                                                                                                  ownerId: string
                                                                                                                                                                                                                                                                                                  role: string
                                                                                                                                                                                                                                                                                                  title: string
                                                                                                                                                                                                                                                                                                  utcDateModified: string
                                                                                                                                                                                                                                                                                                  utcDateScheduledForErasureSince: string

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FAttributeRow.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.FAttributeRow.html new file mode 100644 index 000000000..586d0a0f2 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.FAttributeRow.html @@ -0,0 +1,8 @@ +FAttributeRow | trilium
                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                    Interface FAttributeRow

                                                                                                                                                                                                                                                                                                    interface FAttributeRow {
                                                                                                                                                                                                                                                                                                        attributeId: string;
                                                                                                                                                                                                                                                                                                        isInheritable: boolean;
                                                                                                                                                                                                                                                                                                        name: string;
                                                                                                                                                                                                                                                                                                        noteId: string;
                                                                                                                                                                                                                                                                                                        position: number;
                                                                                                                                                                                                                                                                                                        type: AttributeType;
                                                                                                                                                                                                                                                                                                        value: string;
                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    attributeId +isInheritable +name +noteId +position +type +value +

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    attributeId: string
                                                                                                                                                                                                                                                                                                    isInheritable: boolean
                                                                                                                                                                                                                                                                                                    name: string
                                                                                                                                                                                                                                                                                                    noteId: string
                                                                                                                                                                                                                                                                                                    position: number
                                                                                                                                                                                                                                                                                                    type: AttributeType
                                                                                                                                                                                                                                                                                                    value: string

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FBranchRow.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.FBranchRow.html new file mode 100644 index 000000000..6436f5b6c --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.FBranchRow.html @@ -0,0 +1,9 @@ +FBranchRow | trilium
                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                      Interface FBranchRow

                                                                                                                                                                                                                                                                                                      interface FBranchRow {
                                                                                                                                                                                                                                                                                                          branchId: string;
                                                                                                                                                                                                                                                                                                          fromSearchNote: boolean;
                                                                                                                                                                                                                                                                                                          isDeleted?: boolean;
                                                                                                                                                                                                                                                                                                          isExpanded?: boolean;
                                                                                                                                                                                                                                                                                                          noteId: string;
                                                                                                                                                                                                                                                                                                          notePosition: number;
                                                                                                                                                                                                                                                                                                          parentNoteId: string;
                                                                                                                                                                                                                                                                                                          prefix?: string;
                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      branchId +fromSearchNote +isDeleted? +isExpanded? +noteId +notePosition +parentNoteId +prefix? +

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      branchId: string
                                                                                                                                                                                                                                                                                                      fromSearchNote: boolean
                                                                                                                                                                                                                                                                                                      isDeleted?: boolean
                                                                                                                                                                                                                                                                                                      isExpanded?: boolean
                                                                                                                                                                                                                                                                                                      noteId: string
                                                                                                                                                                                                                                                                                                      notePosition: number
                                                                                                                                                                                                                                                                                                      parentNoteId: string
                                                                                                                                                                                                                                                                                                      prefix?: string

                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FNoteRow.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.FNoteRow.html new file mode 100644 index 000000000..85eaa3670 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.FNoteRow.html @@ -0,0 +1,7 @@ +FNoteRow | trilium
                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                        Interface FNoteRow

                                                                                                                                                                                                                                                                                                        interface FNoteRow {
                                                                                                                                                                                                                                                                                                            blobId: string;
                                                                                                                                                                                                                                                                                                            isProtected: boolean;
                                                                                                                                                                                                                                                                                                            mime: string;
                                                                                                                                                                                                                                                                                                            noteId: string;
                                                                                                                                                                                                                                                                                                            title: string;
                                                                                                                                                                                                                                                                                                            type: NoteType;
                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        blobId +isProtected +mime +noteId +title +type +

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        blobId: string
                                                                                                                                                                                                                                                                                                        isProtected: boolean
                                                                                                                                                                                                                                                                                                        mime: string
                                                                                                                                                                                                                                                                                                        noteId: string
                                                                                                                                                                                                                                                                                                        title: string
                                                                                                                                                                                                                                                                                                        type: NoteType

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Fancytree.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Fancytree.html new file mode 100644 index 000000000..0d6ae776b --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Fancytree.html @@ -0,0 +1,108 @@ +Fancytree | trilium
                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                          Interface Fancytree

                                                                                                                                                                                                                                                                                                          interface Fancytree {
                                                                                                                                                                                                                                                                                                              $container: JQuery;
                                                                                                                                                                                                                                                                                                              $div: JQuery;
                                                                                                                                                                                                                                                                                                              focusNode: FancytreeNode;
                                                                                                                                                                                                                                                                                                              options: FancytreeOptions;
                                                                                                                                                                                                                                                                                                              rootNode: FancytreeNode;
                                                                                                                                                                                                                                                                                                              widget: any;
                                                                                                                                                                                                                                                                                                              activateKey(key: string | boolean): FancytreeNode;
                                                                                                                                                                                                                                                                                                              applyPatch(patchList: NodePatch[]): JQueryPromise<any>;
                                                                                                                                                                                                                                                                                                              changeRefKey(oldRefKey: string, newRefKey: string): void;
                                                                                                                                                                                                                                                                                                              clearCookies(): void;
                                                                                                                                                                                                                                                                                                              clearFilter(): void;
                                                                                                                                                                                                                                                                                                              count(): number;
                                                                                                                                                                                                                                                                                                              debug(msg: any): void;
                                                                                                                                                                                                                                                                                                              enableUpdate(enabled: boolean): void;
                                                                                                                                                                                                                                                                                                              expandAll(flag?: boolean, options?: Object): void;
                                                                                                                                                                                                                                                                                                              filterBranches(filter: string): number;
                                                                                                                                                                                                                                                                                                              filterBranches(filter: (node: FancytreeNode) => boolean): number;
                                                                                                                                                                                                                                                                                                              filterNodes(filter: string, leavesOnly?: boolean): number;
                                                                                                                                                                                                                                                                                                              filterNodes(
                                                                                                                                                                                                                                                                                                                  filter: (node: FancytreeNode) => boolean,
                                                                                                                                                                                                                                                                                                                  leavesOnly?: boolean,
                                                                                                                                                                                                                                                                                                              ): number;
                                                                                                                                                                                                                                                                                                              findAll(
                                                                                                                                                                                                                                                                                                                  match: string | ((node: FancytreeNode) => undefined | boolean),
                                                                                                                                                                                                                                                                                                              ): FancytreeNode[];
                                                                                                                                                                                                                                                                                                              findNextNode(match: string, startNode?: FancytreeNode): FancytreeNode;
                                                                                                                                                                                                                                                                                                              findNextNode(
                                                                                                                                                                                                                                                                                                                  match: (node: FancytreeNode) => boolean,
                                                                                                                                                                                                                                                                                                                  startNode?: FancytreeNode,
                                                                                                                                                                                                                                                                                                              ): FancytreeNode;
                                                                                                                                                                                                                                                                                                              generateFormElements(selected?: boolean, active?: boolean): void;
                                                                                                                                                                                                                                                                                                              getActiveNode(): FancytreeNode;
                                                                                                                                                                                                                                                                                                              getFirstChild(): FancytreeNode;
                                                                                                                                                                                                                                                                                                              getFocusNode(ifTreeHasFocus?: boolean): FancytreeNode;
                                                                                                                                                                                                                                                                                                              getNodeByKey(key: string, searchRoot?: FancytreeNode): FancytreeNode;
                                                                                                                                                                                                                                                                                                              getNodesByRef(refKey: string, rootNode?: FancytreeNode): FancytreeNode[];
                                                                                                                                                                                                                                                                                                              getPersistData(): PersistData;
                                                                                                                                                                                                                                                                                                              getRootNode(): FancytreeNode;
                                                                                                                                                                                                                                                                                                              getSelectedNodes(stopOnParents?: boolean): FancytreeNode[];
                                                                                                                                                                                                                                                                                                              hasFocus(): boolean;
                                                                                                                                                                                                                                                                                                              info(msg: any): void;
                                                                                                                                                                                                                                                                                                              isEditing(): FancytreeNode;
                                                                                                                                                                                                                                                                                                              loadKeyPath(
                                                                                                                                                                                                                                                                                                                  keyPathList: string[],
                                                                                                                                                                                                                                                                                                                  callback: (node: FancytreeNode, status: string) => void,
                                                                                                                                                                                                                                                                                                              ): JQueryPromise<any>;
                                                                                                                                                                                                                                                                                                              loadKeyPath(
                                                                                                                                                                                                                                                                                                                  keyPath: string,
                                                                                                                                                                                                                                                                                                                  callback: (node: FancytreeNode, status: string) => void,
                                                                                                                                                                                                                                                                                                              ): JQueryPromise<any>;
                                                                                                                                                                                                                                                                                                              reactivate(): void;
                                                                                                                                                                                                                                                                                                              reload(source?: any): JQueryPromise<any>;
                                                                                                                                                                                                                                                                                                              render(force?: boolean, deep?: boolean): void;
                                                                                                                                                                                                                                                                                                              setFocus(flag?: boolean): void;
                                                                                                                                                                                                                                                                                                              toDict(
                                                                                                                                                                                                                                                                                                                  includeRoot?: boolean,
                                                                                                                                                                                                                                                                                                                  callback?: (node: FancytreeNode) => void,
                                                                                                                                                                                                                                                                                                              ): any;
                                                                                                                                                                                                                                                                                                              visit(fn: (node: FancytreeNode) => any): boolean;
                                                                                                                                                                                                                                                                                                              warn(msg: any): void;
                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          $container +$div +focusNode +options +rootNode +widget +

                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                          activateKey +applyPatch +changeRefKey +clearCookies +clearFilter +count +debug +enableUpdate +expandAll +filterBranches +filterNodes +findAll +findNextNode +generateFormElements +getActiveNode +getFirstChild +getFocusNode +getNodeByKey +getNodesByRef +getPersistData +getRootNode +getSelectedNodes +hasFocus +info +isEditing +loadKeyPath +reactivate +reload +render +setFocus +toDict +visit +warn +

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          $container: JQuery
                                                                                                                                                                                                                                                                                                          $div: JQuery
                                                                                                                                                                                                                                                                                                          focusNode: FancytreeNode
                                                                                                                                                                                                                                                                                                          options: FancytreeOptions
                                                                                                                                                                                                                                                                                                          rootNode: FancytreeNode
                                                                                                                                                                                                                                                                                                          widget: any

                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                          • Activate node with a given key and fire focus and +activate events. A previously activated node will be +deactivated. If activeVisible option is set, all parents +will be expanded as necessary. Pass key = false, to deactivate +the current node only.

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                            • key: string | boolean

                                                                                                                                                                                                                                                                                                            Returns FancytreeNode

                                                                                                                                                                                                                                                                                                            activate node (null, if not found)

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                          • [ext-clones] Replace a refKey with a new one.

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                            • oldRefKey: string
                                                                                                                                                                                                                                                                                                            • newRefKey: string

                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                          • [ext-persist] Remove persistence cookies of the given type(s). +Called like $("#tree").fancytree("getTree").clearCookies("active expanded focus selected");

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                          • Temporarily suppress rendering to improve performance on bulk-updates.

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                            • enabled: boolean

                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                            previous status

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            2.19

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                          • Generate INPUT elements that can be submitted with html forms. In selectMode 3 only the topmost selected nodes are considered.

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                            • Optionalselected: boolean
                                                                                                                                                                                                                                                                                                            • Optionalactive: boolean

                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                          • Make sure that a node with a given ID is loaded, by traversing - and loading - its parents. This method is ment for lazy hierarchies. A callback is executed for every node as we go.

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                            • keyPathList: string[]

                                                                                                                                                                                                                                                                                                              one or more key paths (e.g. '/3/2_1/7')

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                            • callback: (node: FancytreeNode, status: string) => void

                                                                                                                                                                                                                                                                                                              callback(node, status) is called for every visited node ('loading', 'loaded', 'ok', 'error')

                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                            Returns JQueryPromise<any>

                                                                                                                                                                                                                                                                                                          • Make sure that a node with a given ID is loaded, by traversing - and loading - its parents. This method is ment for lazy hierarchies. A callback is executed for every node as we go.

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                            • keyPath: string

                                                                                                                                                                                                                                                                                                              a key path (e.g. '/3/2_1/7')

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                            • callback: (node: FancytreeNode, status: string) => void

                                                                                                                                                                                                                                                                                                              callback(node, status) is called for every visited node ('loading', 'loaded', 'ok', 'error')

                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                            Returns JQueryPromise<any>

                                                                                                                                                                                                                                                                                                          • Render tree (i.e. create DOM elements for all top-level nodes).

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                            • Optionalforce: boolean

                                                                                                                                                                                                                                                                                                              create DOM elements, even is parent is collapsed (default = false)

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                            • Optionaldeep: boolean

                                                                                                                                                                                                                                                                                                              (default = false)

                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                          • Return all nodes as nested list of NodeData.

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                            • OptionalincludeRoot: boolean

                                                                                                                                                                                                                                                                                                              Returns the hidden system root node (and its children) (default = false)

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                            • Optionalcallback: (node: FancytreeNode) => void

                                                                                                                                                                                                                                                                                                              Called for every node

                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                            Returns any

                                                                                                                                                                                                                                                                                                          • Call fn(node) for all nodes.

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                            • fn: (node: FancytreeNode) => any

                                                                                                                                                                                                                                                                                                              the callback function. Return false to stop iteration, return "skip" to skip this node and children only.

                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                            false, if the iterator was stopped.

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeEvents.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeEvents.html new file mode 100644 index 000000000..21b382344 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeEvents.html @@ -0,0 +1,60 @@ +FancytreeEvents | trilium
                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                            Interface FancytreeEvents

                                                                                                                                                                                                                                                                                                            The this context of any event function is set to tree's the HTMLDivElement

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            interface FancytreeEvents {
                                                                                                                                                                                                                                                                                                                rtl?: boolean;
                                                                                                                                                                                                                                                                                                                activate(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                beforeActivate(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                                                                                beforeExpand(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                                                                                beforeSelect(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                                                                                blur(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                blurTree(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                click(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                                                                                collapse(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                create(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                createNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                dblclick(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                                                                                deactivate(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                expand(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                focus(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                focusTree(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                init(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                keydown(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                                                                                keypress(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                lazyLoad(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                loadChildren(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                loadError(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                                                                                postProcess(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                removeNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                renderColumns(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                renderNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                renderTitle(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                restore(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                select(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            rtl? +

                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                            activate? +beforeActivate? +beforeExpand? +beforeSelect? +blur? +blurTree? +click? +collapse? +create? +createNode? +dblclick? +deactivate? +expand? +focus? +focusTree? +init? +keydown? +keypress? +lazyLoad? +loadChildren? +loadError? +postProcess? +removeNode? +renderColumns? +renderNode? +renderTitle? +restore? +select? +

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            rtl?: boolean

                                                                                                                                                                                                                                                                                                            Enable RTL version, default is false

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeNode.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeNode.html new file mode 100644 index 000000000..6ec1eb479 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeNode.html @@ -0,0 +1,276 @@ +FancytreeNode | trilium
                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                              Interface FancytreeNode

                                                                                                                                                                                                                                                                                                              A FancytreeNode represents the hierarchical data model and operations.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              interface FancytreeNode {
                                                                                                                                                                                                                                                                                                                  children: FancytreeNode[];
                                                                                                                                                                                                                                                                                                                  data: any;
                                                                                                                                                                                                                                                                                                                  expanded: boolean;
                                                                                                                                                                                                                                                                                                                  extraClasses: string;
                                                                                                                                                                                                                                                                                                                  folder: boolean;
                                                                                                                                                                                                                                                                                                                  icon: string;
                                                                                                                                                                                                                                                                                                                  key: string;
                                                                                                                                                                                                                                                                                                                  lazy: boolean;
                                                                                                                                                                                                                                                                                                                  parent: FancytreeNode;
                                                                                                                                                                                                                                                                                                                  span: HTMLElement;
                                                                                                                                                                                                                                                                                                                  statusNodeType: string;
                                                                                                                                                                                                                                                                                                                  title: string;
                                                                                                                                                                                                                                                                                                                  tooltip: string;
                                                                                                                                                                                                                                                                                                                  tr: HTMLTableRowElement;
                                                                                                                                                                                                                                                                                                                  tree: Fancytree;
                                                                                                                                                                                                                                                                                                                  unselectable?: boolean;
                                                                                                                                                                                                                                                                                                                  unselectableIgnore?: boolean;
                                                                                                                                                                                                                                                                                                                  unselectableStatus?: boolean;
                                                                                                                                                                                                                                                                                                                  addChildren(
                                                                                                                                                                                                                                                                                                                      children: NodeData[],
                                                                                                                                                                                                                                                                                                                      insertBefore?: FancytreeNode,
                                                                                                                                                                                                                                                                                                                  ): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  addChildren(children: NodeData[], insertBefore?: string): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  addChildren(children: NodeData[], insertBefore?: number): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  addChildren(child: NodeData, insertBefore?: FancytreeNode): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  addChildren(child: NodeData, insertBefore?: string): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  addChildren(child: NodeData, insertBefore?: number): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  addClass(className: string): void;
                                                                                                                                                                                                                                                                                                                  addNode(node: NodeData, mode?: string): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  applyPatch(patch: NodePatch): JQueryPromise<any>;
                                                                                                                                                                                                                                                                                                                  collapseSiblings(): JQueryPromise<any>;
                                                                                                                                                                                                                                                                                                                  copyTo(
                                                                                                                                                                                                                                                                                                                      node: FancytreeNode,
                                                                                                                                                                                                                                                                                                                      mode?: string,
                                                                                                                                                                                                                                                                                                                      map?: (node: NodeData) => void,
                                                                                                                                                                                                                                                                                                                  ): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  countChildren(deep?: boolean): number;
                                                                                                                                                                                                                                                                                                                  debug(msg: any): void;
                                                                                                                                                                                                                                                                                                                  editCreateNode(mode?: string, init?: Object): void;
                                                                                                                                                                                                                                                                                                                  editEnd(applyChanges: boolean): void;
                                                                                                                                                                                                                                                                                                                  editStart(): void;
                                                                                                                                                                                                                                                                                                                  findAll(match: string): FancytreeNode[];
                                                                                                                                                                                                                                                                                                                  findAll(match: (node: FancytreeNode) => boolean): FancytreeNode[];
                                                                                                                                                                                                                                                                                                                  findFirst(match: string): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  findFirst(match: (node: FancytreeNode) => boolean): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  fixSelection3AfterClick(): void;
                                                                                                                                                                                                                                                                                                                  fixSelection3FromEndNodes(): void;
                                                                                                                                                                                                                                                                                                                  fromDict(dict: NodeData): void;
                                                                                                                                                                                                                                                                                                                  getChildren(): FancytreeNode[];
                                                                                                                                                                                                                                                                                                                  getCloneList(includeSelf?: boolean): FancytreeNode[];
                                                                                                                                                                                                                                                                                                                  getFirstChild(): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  getIndex(): number;
                                                                                                                                                                                                                                                                                                                  getIndexHier(): string;
                                                                                                                                                                                                                                                                                                                  getKeyPath(excludeSelf: boolean): string;
                                                                                                                                                                                                                                                                                                                  getLastChild(): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  getLevel(): number;
                                                                                                                                                                                                                                                                                                                  getNextSibling(): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  getParent(): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  getParentList(includeRoot: boolean, includeSelf: boolean): FancytreeNode[];
                                                                                                                                                                                                                                                                                                                  getPrevSibling(): FancytreeNode;
                                                                                                                                                                                                                                                                                                                  hasChildren(): boolean;
                                                                                                                                                                                                                                                                                                                  hasFocus(): boolean;
                                                                                                                                                                                                                                                                                                                  info(msg: string): void;
                                                                                                                                                                                                                                                                                                                  isActive(): boolean;
                                                                                                                                                                                                                                                                                                                  isChildOf(otherNode: FancytreeNode): boolean;
                                                                                                                                                                                                                                                                                                                  isClone(): boolean;
                                                                                                                                                                                                                                                                                                                  isDescendantOf(otherNode: FancytreeNode): boolean;
                                                                                                                                                                                                                                                                                                                  isEditing(): boolean;
                                                                                                                                                                                                                                                                                                                  isExpanded(): boolean;
                                                                                                                                                                                                                                                                                                                  isFirstSibling(): boolean;
                                                                                                                                                                                                                                                                                                                  isFolder(): boolean;
                                                                                                                                                                                                                                                                                                                  isLastSibling(): boolean;
                                                                                                                                                                                                                                                                                                                  isLazy(): boolean;
                                                                                                                                                                                                                                                                                                                  isLoaded(): boolean;
                                                                                                                                                                                                                                                                                                                  isLoading(): boolean;
                                                                                                                                                                                                                                                                                                                  isRootNode(): boolean;
                                                                                                                                                                                                                                                                                                                  isSelected(): boolean;
                                                                                                                                                                                                                                                                                                                  isStatusNode(): boolean;
                                                                                                                                                                                                                                                                                                                  isTopLevel(): boolean;
                                                                                                                                                                                                                                                                                                                  isUndefined(): boolean;
                                                                                                                                                                                                                                                                                                                  isVisible(): boolean;
                                                                                                                                                                                                                                                                                                                  load(forceReload?: boolean): JQueryPromise<any>;
                                                                                                                                                                                                                                                                                                                  makeVisible(opts?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                                                                                  moveTo(
                                                                                                                                                                                                                                                                                                                      targetNode: FancytreeNode,
                                                                                                                                                                                                                                                                                                                      mode: string,
                                                                                                                                                                                                                                                                                                                      map?: (node: FancytreeNode) => void,
                                                                                                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                                                                                                  navigate(where: number, activate?: boolean): JQueryPromise<any>;
                                                                                                                                                                                                                                                                                                                  remove(): void;
                                                                                                                                                                                                                                                                                                                  removeChild(childNode: FancytreeNode): void;
                                                                                                                                                                                                                                                                                                                  removeChildren(): void;
                                                                                                                                                                                                                                                                                                                  removeClass(className: string): void;
                                                                                                                                                                                                                                                                                                                  render(force?: boolean, deep?: boolean): void;
                                                                                                                                                                                                                                                                                                                  renderStatus(): void;
                                                                                                                                                                                                                                                                                                                  renderTitle(): void;
                                                                                                                                                                                                                                                                                                                  reRegister(key: string, refKey: string): boolean;
                                                                                                                                                                                                                                                                                                                  resetLazy(): void;
                                                                                                                                                                                                                                                                                                                  scheduleAction(mode: string, ms: number): void;
                                                                                                                                                                                                                                                                                                                  scrollIntoView(effects?: boolean, options?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                                                                                  scrollIntoView(effects?: Object, options?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                                                                                  setActive(flag?: boolean, opts?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                                                                                  setExpanded(flag?: boolean, opts?: Object): JQueryPromise<any>;
                                                                                                                                                                                                                                                                                                                  setFocus(flag?: boolean): void;
                                                                                                                                                                                                                                                                                                                  setSelected(flag?: boolean): void;
                                                                                                                                                                                                                                                                                                                  setStatus(status: string, message?: string, details?: string): void;
                                                                                                                                                                                                                                                                                                                  setTitle(title: string): void;
                                                                                                                                                                                                                                                                                                                  sortChildren(
                                                                                                                                                                                                                                                                                                                      cmp?: (a: FancytreeNode, b: FancytreeNode) => number,
                                                                                                                                                                                                                                                                                                                      deep?: boolean,
                                                                                                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                                                                                                  toDict(recursive?: boolean, callback?: (dict: NodeData) => void): NodeData;
                                                                                                                                                                                                                                                                                                                  toggleClass(className: string, flag?: boolean): boolean;
                                                                                                                                                                                                                                                                                                                  toggleExpanded(): void;
                                                                                                                                                                                                                                                                                                                  toggleSelected(): void;
                                                                                                                                                                                                                                                                                                                  visit(fn: (node: FancytreeNode) => any, includeSelf?: boolean): boolean;
                                                                                                                                                                                                                                                                                                                  visitAndLoad(
                                                                                                                                                                                                                                                                                                                      fn: (node: FancytreeNode) => any,
                                                                                                                                                                                                                                                                                                                      includeSelf?: boolean,
                                                                                                                                                                                                                                                                                                                  ): JQueryPromise<any>;
                                                                                                                                                                                                                                                                                                                  visitParents(
                                                                                                                                                                                                                                                                                                                      fn: (node: FancytreeNode) => any,
                                                                                                                                                                                                                                                                                                                      includeSelf?: boolean,
                                                                                                                                                                                                                                                                                                                  ): boolean;
                                                                                                                                                                                                                                                                                                                  warn(msg: any): void;
                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              children +data +expanded +extraClasses +folder +icon +key +lazy +parent +span +statusNodeType +title +tooltip +tr +tree +unselectable? +unselectableIgnore? +unselectableStatus? +

                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                              addChildren +addClass +addNode +applyPatch +collapseSiblings +copyTo +countChildren +debug +editCreateNode +editEnd +editStart +findAll +findFirst +fixSelection3AfterClick +fixSelection3FromEndNodes +fromDict +getChildren +getCloneList +getFirstChild +getIndex +getIndexHier +getKeyPath +getLastChild +getLevel +getNextSibling +getParent +getParentList +getPrevSibling +hasChildren +hasFocus +info +isActive +isChildOf +isClone +isDescendantOf +isEditing +isExpanded +isFirstSibling +isFolder +isLastSibling +isLazy +isLoaded +isLoading +isRootNode +isSelected +isStatusNode +isTopLevel +isUndefined +isVisible +load +makeVisible +moveTo +navigate +remove +removeChild +removeChildren +removeClass +render +renderStatus +renderTitle +reRegister +resetLazy +scheduleAction +scrollIntoView +setActive +setExpanded +setFocus +setSelected +setStatus +setTitle +sortChildren +toDict +toggleClass +toggleExpanded +toggleSelected +visit +visitAndLoad +visitParents +warn +

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              children: FancytreeNode[]

                                                                                                                                                                                                                                                                                                              Array of child nodes. For lazy nodes, null or undefined means 'not yet loaded'. Use an empty array to define a node that has no children.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              data: any

                                                                                                                                                                                                                                                                                                              Contains all extra data that was passed on node creation

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              expanded: boolean

                                                                                                                                                                                                                                                                                                              Use isExpanded(), setExpanded() to access this property.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              extraClasses: string

                                                                                                                                                                                                                                                                                                              Addtional CSS classes, added to the node's <span>.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              folder: boolean

                                                                                                                                                                                                                                                                                                              Folder nodes have different default icons and click behavior. Note: Also non-folders may have children.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              icon: string

                                                                                                                                                                                                                                                                                                              Icon of the tree node.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              key: string

                                                                                                                                                                                                                                                                                                              Node id (must be unique inside the tree)

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              lazy: boolean

                                                                                                                                                                                                                                                                                                              True if this node is loaded on demand, i.e. on first expansion.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              parent: FancytreeNode

                                                                                                                                                                                                                                                                                                              The parent node

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              span: HTMLElement

                                                                                                                                                                                                                                                                                                              Outer element of single nodes

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              statusNodeType: string

                                                                                                                                                                                                                                                                                                              null or type of temporarily generated system node like 'loading', or 'error'.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              title: string

                                                                                                                                                                                                                                                                                                              Display name (may contain HTML)

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              tooltip: string

                                                                                                                                                                                                                                                                                                              Alternative description used as hover banner

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              tr: HTMLTableRowElement

                                                                                                                                                                                                                                                                                                              Outer element of single nodes for table extension

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              tree: Fancytree

                                                                                                                                                                                                                                                                                                              The tree instance

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              unselectable?: boolean
                                                                                                                                                                                                                                                                                                              unselectableIgnore?: boolean
                                                                                                                                                                                                                                                                                                              unselectableStatus?: boolean

                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                              • Count direct and indirect children.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • Optionaldeep: boolean

                                                                                                                                                                                                                                                                                                                  pass 'false' to only count direct children. (default=true)

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                Returns number

                                                                                                                                                                                                                                                                                                              • [ext-edit] Create a new child or sibling node and start edit mode.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • Optionalmode: string

                                                                                                                                                                                                                                                                                                                  'before', 'after', or 'child' (default='child')

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • Optionalinit: Object

                                                                                                                                                                                                                                                                                                                  NodeData (or simple title string)

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                              • [ext-edit] Stop inline editing.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • applyChanges: boolean

                                                                                                                                                                                                                                                                                                                  false: cancel edit, true: save (if modified)

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                              • Fix selection status, after this node was (de)selected in multi-hier mode. This includes (de)selecting all children.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                              • Fix selection status for multi-hier mode. Only end-nodes are considered to update the descendants branch and parents. Should be called after this node has loaded new children or after children have been modified using the API.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                              • Return the parent keys separated by options.keyPathSeparator, e.g. "id_1/id_17/id_32".

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • excludeSelf: boolean

                                                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                                              • Return an array of all parent nodes (top-down).

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • includeRoot: boolean

                                                                                                                                                                                                                                                                                                                  Include the invisible system root node. (default=false)

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • includeSelf: boolean

                                                                                                                                                                                                                                                                                                                  Include the node itself (default=false).

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                Returns FancytreeNode[]

                                                                                                                                                                                                                                                                                                              • Return true if node has children. Return undefined if not sure, i.e. the node is lazy and not yet loaded).

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                              • Return true if this node is a temporarily generated system node like 'loading', or 'error' (node.statusNodeType contains the type).

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                              • Return true if all parent nodes are expanded. Note: this does not check whether the node is scrolled into the visible part of the screen.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                              • Expand all parents and optionally scroll into visible area as neccessary. Promise is resolved, when lazy loading and animations are done.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • Optionalopts: Object

                                                                                                                                                                                                                                                                                                                  passed to setExpanded(). Defaults to {noAnimation: false, noEvents: false, scrollIntoView: true}

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                Returns JQueryPromise<any>

                                                                                                                                                                                                                                                                                                              • Move this node to targetNode.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • targetNode: FancytreeNode
                                                                                                                                                                                                                                                                                                                • mode: string

                                                                                                                                                                                                                                                                                                                  'child': append this node as last child of targetNode. +This is the default. To be compatble with the D'n'd +hitMode, we also accept 'over'. +'before': add this node as sibling before targetNode. +'after': add this node as sibling after targetNode.

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • Optionalmap: (node: FancytreeNode) => void

                                                                                                                                                                                                                                                                                                                  optional callback(FancytreeNode) to allow modifcations

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                              • Set focus relative to this node and optionally activate.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • where: number

                                                                                                                                                                                                                                                                                                                  The keyCode that would normally trigger this move, e.g. $.ui.keyCode.LEFT would collapse the node if it is expanded or move to the parent oterwise.

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • Optionalactivate: boolean

                                                                                                                                                                                                                                                                                                                  (default=true)

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                Returns JQueryPromise<any>

                                                                                                                                                                                                                                                                                                              • Remove all child nodes and descendents. This converts the node into a leaf. +If this was a lazy node, it is still considered 'loaded'; call node.resetLazy() in order to trigger lazyLoad on next expand.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                              • This method renders and updates all HTML markup that is required to display this node in its current state.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • Optionalforce: boolean

                                                                                                                                                                                                                                                                                                                  re-render, even if html markup was already created

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • Optionaldeep: boolean

                                                                                                                                                                                                                                                                                                                  also render all descendants, even if parent is collapsed

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                              • [ext-clones] Update key and/or refKey for an existing node.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • key: string
                                                                                                                                                                                                                                                                                                                • refKey: string

                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                              • Schedule activity for delayed execution (cancel any pending request). scheduleAction('cancel') will only cancel a pending request (if any).

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • mode: string
                                                                                                                                                                                                                                                                                                                • ms: number

                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                              • Select this node, i.e. check the checkbox.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • Optionalflag: boolean

                                                                                                                                                                                                                                                                                                                  pass false to deselect.

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                              • Mark a lazy node as 'error', 'loading', or 'ok'.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • status: string

                                                                                                                                                                                                                                                                                                                  'error', 'ok'

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • Optionalmessage: string
                                                                                                                                                                                                                                                                                                                • Optionaldetails: string

                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                              • Convert node (or whole branch) into a plain object. The result is compatible with node.addChildren().

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • Optionalrecursive: boolean

                                                                                                                                                                                                                                                                                                                  include child nodes.

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • Optionalcallback: (dict: NodeData) => void

                                                                                                                                                                                                                                                                                                                  callback(dict) is called for every node, in order to allow modifications

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                Returns NodeData

                                                                                                                                                                                                                                                                                                              • Set, clear, or toggle class of node's span tag and .extraClasses.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • className: string

                                                                                                                                                                                                                                                                                                                  class name (separate multiple classes by space)

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • Optionalflag: boolean

                                                                                                                                                                                                                                                                                                                  true/false to add/remove class. If omitted, class is toggled.

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                                true if a class was added

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                              • Call fn(node) for all child nodes. +Stop iteration, if fn() returns false. Skip current branch, +if fn() returns "skip". Return false if iteration was stopped.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • fn: (node: FancytreeNode) => any

                                                                                                                                                                                                                                                                                                                  the callback function. Return false to stop iteration, return "skip" to skip this node and its children only.

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • OptionalincludeSelf: boolean

                                                                                                                                                                                                                                                                                                                  (default=false)

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                              • Call fn(node) for all child nodes and recursively load lazy children. +Note: If you need this method, you probably should consider to review your architecture! Recursivley loading nodes is +a perfect way for lazy programmers to flood the server with requests ;-)

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • fn: (node: FancytreeNode) => any

                                                                                                                                                                                                                                                                                                                  the callback function. Return false to stop iteration, return "skip" to skip this node and its children only.

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • OptionalincludeSelf: boolean

                                                                                                                                                                                                                                                                                                                  (default=false)

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                Returns JQueryPromise<any>

                                                                                                                                                                                                                                                                                                              • Call fn(node) for all parent nodes, bottom-up, including invisible system root. +Stop iteration, if fn() returns false. +Return false if iteration was stopped.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • fn: (node: FancytreeNode) => any

                                                                                                                                                                                                                                                                                                                  the callback function. Return false to stop iteration, return "skip" to skip this node and its children only.

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • OptionalincludeSelf: boolean

                                                                                                                                                                                                                                                                                                                  (default=false)

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                              addChildrenaddClassaddNodeapplyPatchcollapseSiblingscopyTocountChildrendebugeditCreateNodeeditEndeditStartfindAllfindFirstfixSelection3AfterClickfixSelection3FromEndNodesfromDictgetChildrengetCloneListgetFirstChildgetIndexgetIndexHiergetKeyPathgetLastChildgetLevelgetNextSiblinggetParentgetParentListgetPrevSiblinghasChildrenhasFocusinfoisActiveisChildOfisCloneisDescendantOfisEditingisExpandedisFirstSiblingisFolderisLastSiblingisLazyisLoadedisLoadingisRootNodeisSelectedisStatusNodeisTopLevelisUndefinedisVisibleloadmakeVisiblemoveTonavigateremoveremoveChildremoveChildrenremoveClassrenderrenderStatusrenderTitlereRegisterresetLazyscheduleActionscrollIntoViewsetActivesetExpandedsetFocussetSelectedsetStatussetTitlesortChildrentoDicttoggleClasstoggleExpandedtoggleSelectedvisitvisitAndLoadvisitParentswarn
                                                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeOptions.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeOptions.html new file mode 100644 index 000000000..20368f5ed --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.FancytreeOptions.html @@ -0,0 +1,135 @@ +FancytreeOptions | trilium
                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                Interface FancytreeOptions

                                                                                                                                                                                                                                                                                                                The this context of any event function is set to tree's the HTMLDivElement

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                interface FancytreeOptions {
                                                                                                                                                                                                                                                                                                                    activeVisible?: boolean;
                                                                                                                                                                                                                                                                                                                    ajax?: { cache: boolean; dataType: string; type: string };
                                                                                                                                                                                                                                                                                                                    aria?: boolean;
                                                                                                                                                                                                                                                                                                                    autoActivate?: boolean;
                                                                                                                                                                                                                                                                                                                    autoCollapse?: boolean;
                                                                                                                                                                                                                                                                                                                    autoScroll?: boolean;
                                                                                                                                                                                                                                                                                                                    checkbox?:
                                                                                                                                                                                                                                                                                                                        | string
                                                                                                                                                                                                                                                                                                                        | boolean
                                                                                                                                                                                                                                                                                                                        | ((event: JQueryEventObject, data: EventData) => boolean);
                                                                                                                                                                                                                                                                                                                    clickFolderMode?: FancytreeClickFolderMode;
                                                                                                                                                                                                                                                                                                                    debugLevel?: 0 | 1 | 2 | 3 | 4;
                                                                                                                                                                                                                                                                                                                    defaultKey?: (node: FancytreeNode) => string;
                                                                                                                                                                                                                                                                                                                    dnd5?: DragAndDrop5;
                                                                                                                                                                                                                                                                                                                    enableAspx?: boolean;
                                                                                                                                                                                                                                                                                                                    enableTitles?: boolean;
                                                                                                                                                                                                                                                                                                                    extensions?: (keyof List)[];
                                                                                                                                                                                                                                                                                                                    filter?: Filter;
                                                                                                                                                                                                                                                                                                                    focusOnSelect?: boolean;
                                                                                                                                                                                                                                                                                                                    generateIds?: boolean;
                                                                                                                                                                                                                                                                                                                    icon?: string | boolean;
                                                                                                                                                                                                                                                                                                                    idPrefix?: string;
                                                                                                                                                                                                                                                                                                                    imagePath?: string;
                                                                                                                                                                                                                                                                                                                    keyboard?: boolean;
                                                                                                                                                                                                                                                                                                                    keyPathSeparator?: string;
                                                                                                                                                                                                                                                                                                                    minExpandLevel?: number;
                                                                                                                                                                                                                                                                                                                    quicksearch?: boolean;
                                                                                                                                                                                                                                                                                                                    rtl?: boolean;
                                                                                                                                                                                                                                                                                                                    scrollOfs?: { bottom: number; top: number };
                                                                                                                                                                                                                                                                                                                    scrollParent?: null | JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                                                                    selectMode?: FancytreeSelectMode;
                                                                                                                                                                                                                                                                                                                    source?: any;
                                                                                                                                                                                                                                                                                                                    strings?: TranslationTable;
                                                                                                                                                                                                                                                                                                                    tabbable?: boolean;
                                                                                                                                                                                                                                                                                                                    table?: Table;
                                                                                                                                                                                                                                                                                                                    titlesTabbable?: boolean;
                                                                                                                                                                                                                                                                                                                    toggleEffect?: any;
                                                                                                                                                                                                                                                                                                                    tooltip?: boolean;
                                                                                                                                                                                                                                                                                                                    unselectable?:
                                                                                                                                                                                                                                                                                                                        | boolean
                                                                                                                                                                                                                                                                                                                        | ((event: JQueryEventObject, data: EventData) => undefined | boolean);
                                                                                                                                                                                                                                                                                                                    unselectableIgnore?:
                                                                                                                                                                                                                                                                                                                        | boolean
                                                                                                                                                                                                                                                                                                                        | ((event: JQueryEventObject, data: EventData) => undefined | boolean);
                                                                                                                                                                                                                                                                                                                    unselectableStatus?:
                                                                                                                                                                                                                                                                                                                        | boolean
                                                                                                                                                                                                                                                                                                                        | ((event: JQueryEventObject, data: EventData) => undefined | boolean);
                                                                                                                                                                                                                                                                                                                    activate(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    beforeActivate(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                                                                                    beforeExpand(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                                                                                    beforeSelect(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                                                                                    blur(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    blurTree(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    click(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                                                                                    collapse(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    create(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    createNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    dblclick(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                                                                                    deactivate(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    expand(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    focus(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    focusTree(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    init(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    keydown(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                                                                                    keypress(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    lazyLoad(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    loadChildren(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    loadError(event: JQueryEventObject, data: EventData): boolean;
                                                                                                                                                                                                                                                                                                                    postProcess(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    removeNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    renderColumns(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    renderNode(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    renderTitle(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    restore(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    select(event: JQueryEventObject, data: EventData): void;
                                                                                                                                                                                                                                                                                                                    [extension: string]: any;
                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                • [extension: string]: any

                                                                                                                                                                                                                                                                                                                  Options for misc extensions - see docs for typings

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                activeVisible? +ajax? +aria? +autoActivate? +autoCollapse? +autoScroll? +checkbox? +clickFolderMode? +debugLevel? +defaultKey? +dnd5? +enableAspx? +enableTitles? +extensions? +filter? +focusOnSelect? +generateIds? +icon? +idPrefix? +imagePath? +keyboard? +keyPathSeparator? +minExpandLevel? +quicksearch? +rtl? +scrollOfs? +scrollParent? +selectMode? +source? +strings? +tabbable? +table? +titlesTabbable? +toggleEffect? +tooltip? +unselectable? +unselectableIgnore? +unselectableStatus? +

                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                activate? +beforeActivate? +beforeExpand? +beforeSelect? +blur? +blurTree? +click? +collapse? +create? +createNode? +dblclick? +deactivate? +expand? +focus? +focusTree? +init? +keydown? +keypress? +lazyLoad? +loadChildren? +loadError? +postProcess? +removeNode? +renderColumns? +renderNode? +renderTitle? +restore? +select? +

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                activeVisible?: boolean

                                                                                                                                                                                                                                                                                                                Make sure that the active node is always visible, i.e. its parents are expanded (default: true).

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                ajax?: { cache: boolean; dataType: string; type: string }

                                                                                                                                                                                                                                                                                                                Default options for ajax requests.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                • cache: boolean

                                                                                                                                                                                                                                                                                                                  false: Append random '_' argument to the request url to prevent caching.

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • dataType: string

                                                                                                                                                                                                                                                                                                                  Default 'json' -> Expect json format and pass json object to callbacks.

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • type: string

                                                                                                                                                                                                                                                                                                                  HTTP Method (default: 'GET')

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                aria?: boolean

                                                                                                                                                                                                                                                                                                                (default: false) Add WAI-ARIA attributes to markup

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                autoActivate?: boolean

                                                                                                                                                                                                                                                                                                                Activate a node when focused with the keyboard (default: true)

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                autoCollapse?: boolean

                                                                                                                                                                                                                                                                                                                Automatically collapse all siblings, when a node is expanded (default: false).

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                autoScroll?: boolean

                                                                                                                                                                                                                                                                                                                Scroll node into visible area, when focused by keyboard (default: false).

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                checkbox?:
                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                    | boolean
                                                                                                                                                                                                                                                                                                                    | ((event: JQueryEventObject, data: EventData) => boolean)

                                                                                                                                                                                                                                                                                                                Display checkboxes to allow selection (default: false)

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                clickFolderMode?: FancytreeClickFolderMode

                                                                                                                                                                                                                                                                                                                Defines what happens, when the user click a folder node. (default: activate_dblclick_expands)

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                debugLevel?: 0 | 1 | 2 | 3 | 4

                                                                                                                                                                                                                                                                                                                0..4 (null: use global setting $.ui.fancytree.debugInfo)

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                defaultKey?: (node: FancytreeNode) => string

                                                                                                                                                                                                                                                                                                                callback(node) is called for new nodes without a key. Must return a new unique key. (default null: generates default keys like that: "_" + counter)

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                dnd5?: DragAndDrop5
                                                                                                                                                                                                                                                                                                                enableAspx?: boolean

                                                                                                                                                                                                                                                                                                                Accept passing ajax data in a property named d (default: true).

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                enableTitles?: boolean

                                                                                                                                                                                                                                                                                                                Enable titles (default: false)

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                extensions?: (keyof List)[]

                                                                                                                                                                                                                                                                                                                List of active extensions (default: [])

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                filter?: Filter
                                                                                                                                                                                                                                                                                                                focusOnSelect?: boolean

                                                                                                                                                                                                                                                                                                                Set focus when node is checked by a mouse click (default: false)

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                generateIds?: boolean

                                                                                                                                                                                                                                                                                                                Add id="..." to node markup (default: true).

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                icon?: string | boolean

                                                                                                                                                                                                                                                                                                                Node icon url, if only filename, please use imagePath to set the path

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                idPrefix?: string

                                                                                                                                                                                                                                                                                                                Prefix (default: "ft_")

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                imagePath?: string

                                                                                                                                                                                                                                                                                                                Path to a folder containing icons (default: null, using 'skin/' subdirectory).

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                keyboard?: boolean

                                                                                                                                                                                                                                                                                                                Support keyboard navigation (default: true).

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                keyPathSeparator?: string

                                                                                                                                                                                                                                                                                                                (default: "/")

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                minExpandLevel?: number

                                                                                                                                                                                                                                                                                                                2: top-level nodes are not collapsible (default: 1)

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                quicksearch?: boolean

                                                                                                                                                                                                                                                                                                                navigate to next node by typing the first letters (default: false)

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                rtl?: boolean

                                                                                                                                                                                                                                                                                                                Right to left mode (default: false)

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                scrollOfs?: { bottom: number; top: number }

                                                                                                                                                                                                                                                                                                                optional margins for node.scrollIntoView() (default: {top: 0, bottom: 0})

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                scrollParent?: null | JQuery<HTMLElement>

                                                                                                                                                                                                                                                                                                                scrollable container for node.scrollIntoView() (default: $container)

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                selectMode?: FancytreeSelectMode

                                                                                                                                                                                                                                                                                                                default: multi_hier

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                source?: any

                                                                                                                                                                                                                                                                                                                Used to Initialize the tree.

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                strings?: TranslationTable

                                                                                                                                                                                                                                                                                                                Translation table

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                tabbable?: boolean

                                                                                                                                                                                                                                                                                                                Add tabindex='0' to container, so tree can be reached using TAB

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                table?: Table
                                                                                                                                                                                                                                                                                                                titlesTabbable?: boolean

                                                                                                                                                                                                                                                                                                                Add tabindex='0' to node title span, so it can receive keyboard focus

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                toggleEffect?: any

                                                                                                                                                                                                                                                                                                                Animation options, false:off (default: { effect: "blind", options: {direction: "vertical", scale: "box"}, duration: 200 })

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                tooltip?: boolean

                                                                                                                                                                                                                                                                                                                Tooltips

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                unselectable?:
                                                                                                                                                                                                                                                                                                                    | boolean
                                                                                                                                                                                                                                                                                                                    | ((event: JQueryEventObject, data: EventData) => undefined | boolean)

                                                                                                                                                                                                                                                                                                                (dynamic Option)Prevent (de-)selection using mouse or keyboard.

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                unselectableIgnore?:
                                                                                                                                                                                                                                                                                                                    | boolean
                                                                                                                                                                                                                                                                                                                    | ((event: JQueryEventObject, data: EventData) => undefined | boolean)

                                                                                                                                                                                                                                                                                                                (dynamic Option)Ignore this node when calculating the partsel status of parent nodes in selectMode 3 propagation.

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                unselectableStatus?:
                                                                                                                                                                                                                                                                                                                    | boolean
                                                                                                                                                                                                                                                                                                                    | ((event: JQueryEventObject, data: EventData) => undefined | boolean)

                                                                                                                                                                                                                                                                                                                (dynamic Option)Use this as constant selected value (overriding selectMode 3 propagation).

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Filter.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Filter.html new file mode 100644 index 000000000..116746306 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Filter.html @@ -0,0 +1,23 @@ +Filter | trilium
                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                  Interface Filter

                                                                                                                                                                                                                                                                                                                  Define filter-extension options

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  interface Filter {
                                                                                                                                                                                                                                                                                                                      autoApply?: boolean;
                                                                                                                                                                                                                                                                                                                      autoExpand?: boolean;
                                                                                                                                                                                                                                                                                                                      counter?: boolean;
                                                                                                                                                                                                                                                                                                                      fuzzy?: boolean;
                                                                                                                                                                                                                                                                                                                      hideExpandedCounter?: boolean;
                                                                                                                                                                                                                                                                                                                      hideExpanders?: boolean;
                                                                                                                                                                                                                                                                                                                      highlight?: boolean;
                                                                                                                                                                                                                                                                                                                      leavesOnly?: boolean;
                                                                                                                                                                                                                                                                                                                      mode?: "hide" | "dimm";
                                                                                                                                                                                                                                                                                                                      nodata?: boolean;
                                                                                                                                                                                                                                                                                                                      [key: string]: any;
                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                  • [key: string]: any

                                                                                                                                                                                                                                                                                                                    Support misc options

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  autoApply? +autoExpand? +counter? +fuzzy? +hideExpandedCounter? +hideExpanders? +highlight? +leavesOnly? +mode? +nodata? +

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  autoApply?: boolean

                                                                                                                                                                                                                                                                                                                  Re-apply last filter if lazy data is loaded

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  autoExpand?: boolean

                                                                                                                                                                                                                                                                                                                  Expand all branches that contain matches while filtered

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  counter?: boolean

                                                                                                                                                                                                                                                                                                                  Show a badge with number of matching child nodes near parent icons

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  fuzzy?: boolean

                                                                                                                                                                                                                                                                                                                  Match single characters in order, e.g. 'fb' will match 'FooBar'

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  hideExpandedCounter?: boolean

                                                                                                                                                                                                                                                                                                                  Hide counter badge if parent is expanded

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  hideExpanders?: boolean

                                                                                                                                                                                                                                                                                                                  Hide expanders if all child nodes are hidden by filter

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  highlight?: boolean

                                                                                                                                                                                                                                                                                                                  Highlight matches by wrapping inside tags

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  leavesOnly?: boolean

                                                                                                                                                                                                                                                                                                                  Match end nodes only

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  mode?: "hide" | "dimm"

                                                                                                                                                                                                                                                                                                                  Grayout unmatched nodes (pass "hide" to remove unmatched node instead); default 'dimm'

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  nodata?: boolean

                                                                                                                                                                                                                                                                                                                  Display a 'no data' status node if result is empty

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Froca.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Froca.html new file mode 100644 index 000000000..50192daea --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Froca.html @@ -0,0 +1,14 @@ +Froca | trilium
                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                    Interface Froca

                                                                                                                                                                                                                                                                                                                    interface Froca {
                                                                                                                                                                                                                                                                                                                        attachments: Record<string, FAttachment>;
                                                                                                                                                                                                                                                                                                                        attributes: Record<string, FAttribute>;
                                                                                                                                                                                                                                                                                                                        blobPromises: Record<string, null | Promise<void | default>>;
                                                                                                                                                                                                                                                                                                                        branches: Record<string, FBranch>;
                                                                                                                                                                                                                                                                                                                        notes: Record<string, FNote>;
                                                                                                                                                                                                                                                                                                                        getAttachmentsForNote(noteId: string): Promise<FAttachment[]>;
                                                                                                                                                                                                                                                                                                                        getBlob(
                                                                                                                                                                                                                                                                                                                            entityType: string,
                                                                                                                                                                                                                                                                                                                            entityId: string,
                                                                                                                                                                                                                                                                                                                        ): Promise<null | void | default>;
                                                                                                                                                                                                                                                                                                                        getBranch(
                                                                                                                                                                                                                                                                                                                            branchId: string,
                                                                                                                                                                                                                                                                                                                            silentNotFoundError?: boolean,
                                                                                                                                                                                                                                                                                                                        ): undefined | FBranch;
                                                                                                                                                                                                                                                                                                                        getBranches(branchIds: string[], silentNotFoundError?: boolean): FBranch[];
                                                                                                                                                                                                                                                                                                                        getNote(
                                                                                                                                                                                                                                                                                                                            noteId: string,
                                                                                                                                                                                                                                                                                                                            silentNotFoundError?: boolean,
                                                                                                                                                                                                                                                                                                                        ): Promise<null | FNote>;
                                                                                                                                                                                                                                                                                                                        getNoteFromCache(noteId: string): FNote;
                                                                                                                                                                                                                                                                                                                        getNotes(
                                                                                                                                                                                                                                                                                                                            noteIds: string[],
                                                                                                                                                                                                                                                                                                                            silentNotFoundError?: boolean,
                                                                                                                                                                                                                                                                                                                        ): Promise<FNote[]>;
                                                                                                                                                                                                                                                                                                                        getNotesFromCache(
                                                                                                                                                                                                                                                                                                                            noteIds: string[],
                                                                                                                                                                                                                                                                                                                            silentNotFoundError?: boolean,
                                                                                                                                                                                                                                                                                                                        ): FNote[];
                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    attachments +attributes +blobPromises +branches +notes +

                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                    getAttachmentsForNote +getBlob +getBranch +getBranches +getNote +getNoteFromCache +getNotes +getNotesFromCache +

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    attachments: Record<string, FAttachment>
                                                                                                                                                                                                                                                                                                                    attributes: Record<string, FAttribute>
                                                                                                                                                                                                                                                                                                                    blobPromises: Record<string, null | Promise<void | default>>
                                                                                                                                                                                                                                                                                                                    branches: Record<string, FBranch>
                                                                                                                                                                                                                                                                                                                    notes: Record<string, FNote>

                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryEventObject.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryEventObject.html new file mode 100644 index 000000000..a8d7babb6 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryEventObject.html @@ -0,0 +1,109 @@ +JQueryEventObject | trilium
                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                      Interface JQueryEventObject

                                                                                                                                                                                                                                                                                                                      ​ Deprecated. Use JQuery.Event.

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      interface JQueryEventObject {
                                                                                                                                                                                                                                                                                                                          altKey: boolean;
                                                                                                                                                                                                                                                                                                                          AT_TARGET: 2;
                                                                                                                                                                                                                                                                                                                          bubbles: boolean;
                                                                                                                                                                                                                                                                                                                          BUBBLING_PHASE: 3;
                                                                                                                                                                                                                                                                                                                          button: number;
                                                                                                                                                                                                                                                                                                                          cancelable: boolean;
                                                                                                                                                                                                                                                                                                                          cancelBubble: boolean;
                                                                                                                                                                                                                                                                                                                          CAPTURING_PHASE: 1;
                                                                                                                                                                                                                                                                                                                          char: string;
                                                                                                                                                                                                                                                                                                                          charCode: number;
                                                                                                                                                                                                                                                                                                                          clientX: number;
                                                                                                                                                                                                                                                                                                                          clientY: number;
                                                                                                                                                                                                                                                                                                                          composed: boolean;
                                                                                                                                                                                                                                                                                                                          ctrlKey: boolean;
                                                                                                                                                                                                                                                                                                                          currentTarget: Element;
                                                                                                                                                                                                                                                                                                                          data: any;
                                                                                                                                                                                                                                                                                                                          defaultPrevented: boolean;
                                                                                                                                                                                                                                                                                                                          delegateTarget: Element;
                                                                                                                                                                                                                                                                                                                          eventPhase: number;
                                                                                                                                                                                                                                                                                                                          isTrusted: boolean;
                                                                                                                                                                                                                                                                                                                          key: string;
                                                                                                                                                                                                                                                                                                                          keyCode: number;
                                                                                                                                                                                                                                                                                                                          metaKey: boolean;
                                                                                                                                                                                                                                                                                                                          namespace: string;
                                                                                                                                                                                                                                                                                                                          NONE: 0;
                                                                                                                                                                                                                                                                                                                          offsetX: number;
                                                                                                                                                                                                                                                                                                                          offsetY: number;
                                                                                                                                                                                                                                                                                                                          originalEvent: Event;
                                                                                                                                                                                                                                                                                                                          pageX: number;
                                                                                                                                                                                                                                                                                                                          pageY: number;
                                                                                                                                                                                                                                                                                                                          relatedTarget: Element;
                                                                                                                                                                                                                                                                                                                          result: any;
                                                                                                                                                                                                                                                                                                                          returnValue: boolean;
                                                                                                                                                                                                                                                                                                                          screenX: number;
                                                                                                                                                                                                                                                                                                                          screenY: number;
                                                                                                                                                                                                                                                                                                                          shiftKey: boolean;
                                                                                                                                                                                                                                                                                                                          srcElement: null | EventTarget;
                                                                                                                                                                                                                                                                                                                          target: Element;
                                                                                                                                                                                                                                                                                                                          timeStamp: number;
                                                                                                                                                                                                                                                                                                                          type: string;
                                                                                                                                                                                                                                                                                                                          which: number;
                                                                                                                                                                                                                                                                                                                          composedPath(): EventTarget[];
                                                                                                                                                                                                                                                                                                                          initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
                                                                                                                                                                                                                                                                                                                          isDefaultPrevented(): boolean;
                                                                                                                                                                                                                                                                                                                          isImmediatePropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                          isPropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                          preventDefault(): any;
                                                                                                                                                                                                                                                                                                                          stopImmediatePropagation(): void;
                                                                                                                                                                                                                                                                                                                          stopPropagation(): void;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      altKey +AT_TARGET +bubbles +BUBBLING_PHASE +button +cancelable +cancelBubble +CAPTURING_PHASE +char +charCode +clientX +clientY +composed +ctrlKey +currentTarget +data +defaultPrevented +delegateTarget +eventPhase +isTrusted +key +keyCode +metaKey +namespace +NONE +offsetX +offsetY +originalEvent +pageX +pageY +relatedTarget +result +returnValue +screenX +screenY +shiftKey +srcElement +target +timeStamp +type +which +

                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                      composedPath +initEvent +isDefaultPrevented +isImmediatePropagationStopped +isPropagationStopped +preventDefault +stopImmediatePropagation +stopPropagation +

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      altKey: boolean
                                                                                                                                                                                                                                                                                                                      AT_TARGET: 2
                                                                                                                                                                                                                                                                                                                      bubbles: boolean

                                                                                                                                                                                                                                                                                                                      Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      MDN Reference

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      BUBBLING_PHASE: 3
                                                                                                                                                                                                                                                                                                                      button: number
                                                                                                                                                                                                                                                                                                                      cancelable: boolean

                                                                                                                                                                                                                                                                                                                      Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      MDN Reference

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      cancelBubble: boolean

                                                                                                                                                                                                                                                                                                                      MDN Reference

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      CAPTURING_PHASE: 1
                                                                                                                                                                                                                                                                                                                      char: string
                                                                                                                                                                                                                                                                                                                      charCode: number
                                                                                                                                                                                                                                                                                                                      clientX: number
                                                                                                                                                                                                                                                                                                                      clientY: number
                                                                                                                                                                                                                                                                                                                      composed: boolean

                                                                                                                                                                                                                                                                                                                      Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      MDN Reference

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      ctrlKey: boolean
                                                                                                                                                                                                                                                                                                                      currentTarget: Element

                                                                                                                                                                                                                                                                                                                      The current DOM element within the event bubbling phase.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.currentTarget/">https://api.jquery.com/event.currentTarget/</a>

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      data: any

                                                                                                                                                                                                                                                                                                                      An optional object of data passed to an event method when the current executing handler is bound.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.data/">https://api.jquery.com/event.data/</a>

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      defaultPrevented: boolean

                                                                                                                                                                                                                                                                                                                      Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      MDN Reference

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      delegateTarget: Element

                                                                                                                                                                                                                                                                                                                      The element where the currently-called jQuery event handler was attached.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.delegateTarget/">https://api.jquery.com/event.delegateTarget/</a>

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      eventPhase: number

                                                                                                                                                                                                                                                                                                                      Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      MDN Reference

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      isTrusted: boolean

                                                                                                                                                                                                                                                                                                                      Returns true if event was dispatched by the user agent, and false otherwise.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      MDN Reference

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      key: string
                                                                                                                                                                                                                                                                                                                      keyCode: number
                                                                                                                                                                                                                                                                                                                      metaKey: boolean

                                                                                                                                                                                                                                                                                                                      Indicates whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.metaKey/">https://api.jquery.com/event.metaKey/</a>

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      namespace: string

                                                                                                                                                                                                                                                                                                                      The namespace specified when the event was triggered.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.namespace/">https://api.jquery.com/event.namespace/</a>

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      NONE: 0
                                                                                                                                                                                                                                                                                                                      offsetX: number
                                                                                                                                                                                                                                                                                                                      offsetY: number
                                                                                                                                                                                                                                                                                                                      originalEvent: Event

                                                                                                                                                                                                                                                                                                                      The browser's original Event object.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/category/events/event-object/">https://api.jquery.com/category/events/event-object/</a>

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      pageX: number

                                                                                                                                                                                                                                                                                                                      The mouse position relative to the left edge of the document.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.pageX/">https://api.jquery.com/event.pageX/</a>

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      pageY: number

                                                                                                                                                                                                                                                                                                                      The mouse position relative to the top edge of the document.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.pageY/">https://api.jquery.com/event.pageY/</a>

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      relatedTarget: Element

                                                                                                                                                                                                                                                                                                                      The other DOM element involved in the event, if any.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.relatedTarget/">https://api.jquery.com/event.relatedTarget/</a>

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      result: any

                                                                                                                                                                                                                                                                                                                      The last value returned by an event handler that was triggered by this event, unless the value was undefined.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.result/">https://api.jquery.com/event.result/</a>

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      returnValue: boolean

                                                                                                                                                                                                                                                                                                                      MDN Reference

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      screenX: number
                                                                                                                                                                                                                                                                                                                      screenY: number
                                                                                                                                                                                                                                                                                                                      shiftKey: boolean
                                                                                                                                                                                                                                                                                                                      srcElement: null | EventTarget

                                                                                                                                                                                                                                                                                                                      MDN Reference

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      target: Element

                                                                                                                                                                                                                                                                                                                      The DOM element that initiated the event.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.target/">https://api.jquery.com/event.target/</a>

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      timeStamp: number

                                                                                                                                                                                                                                                                                                                      Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      MDN Reference

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      type: string

                                                                                                                                                                                                                                                                                                                      Returns the type of event, e.g. "click", "hashchange", or "submit".

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      MDN Reference

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      which: number

                                                                                                                                                                                                                                                                                                                      For key or mouse events, this property indicates the specific key or button that was pressed.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.which/">https://api.jquery.com/event.which/</a>

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                      • Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        MDN Reference

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Returns EventTarget[]

                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                        • type: string
                                                                                                                                                                                                                                                                                                                        • Optionalbubbles: boolean
                                                                                                                                                                                                                                                                                                                        • Optionalcancelable: boolean

                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                        MDN Reference

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      • Returns whether event.preventDefault() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.isDefaultPrevented/">https://api.jquery.com/event.isDefaultPrevented/</a>

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      • Returns whether event.stopImmediatePropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.isImmediatePropagationStopped/">https://api.jquery.com/event.isImmediatePropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      • Returns whether event.stopPropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.isPropagationStopped/">https://api.jquery.com/event.isPropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      • If this method is called, the default action of the event will not be triggered.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Returns any

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.preventDefault/">https://api.jquery.com/event.preventDefault/</a>

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      • Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.stopImmediatePropagation/">https://api.jquery.com/event.stopImmediatePropagation/</a>

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      • Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.stopPropagation/">https://api.jquery.com/event.stopPropagation/</a>

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryInputEventObject.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryInputEventObject.html new file mode 100644 index 000000000..0663fa7f5 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryInputEventObject.html @@ -0,0 +1,98 @@ +JQueryInputEventObject | trilium
                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                        Interface JQueryInputEventObject

                                                                                                                                                                                                                                                                                                                        ​ Deprecated. Use JQuery.Event.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        interface JQueryInputEventObject {
                                                                                                                                                                                                                                                                                                                            altKey: boolean;
                                                                                                                                                                                                                                                                                                                            AT_TARGET: 2;
                                                                                                                                                                                                                                                                                                                            bubbles: boolean;
                                                                                                                                                                                                                                                                                                                            BUBBLING_PHASE: 3;
                                                                                                                                                                                                                                                                                                                            cancelable: boolean;
                                                                                                                                                                                                                                                                                                                            cancelBubble: boolean;
                                                                                                                                                                                                                                                                                                                            CAPTURING_PHASE: 1;
                                                                                                                                                                                                                                                                                                                            composed: boolean;
                                                                                                                                                                                                                                                                                                                            ctrlKey: boolean;
                                                                                                                                                                                                                                                                                                                            currentTarget: Element;
                                                                                                                                                                                                                                                                                                                            data: any;
                                                                                                                                                                                                                                                                                                                            defaultPrevented: boolean;
                                                                                                                                                                                                                                                                                                                            delegateTarget: Element;
                                                                                                                                                                                                                                                                                                                            eventPhase: number;
                                                                                                                                                                                                                                                                                                                            isTrusted: boolean;
                                                                                                                                                                                                                                                                                                                            metaKey: boolean;
                                                                                                                                                                                                                                                                                                                            namespace: string;
                                                                                                                                                                                                                                                                                                                            NONE: 0;
                                                                                                                                                                                                                                                                                                                            originalEvent: Event;
                                                                                                                                                                                                                                                                                                                            pageX: number;
                                                                                                                                                                                                                                                                                                                            pageY: number;
                                                                                                                                                                                                                                                                                                                            relatedTarget: Element;
                                                                                                                                                                                                                                                                                                                            result: any;
                                                                                                                                                                                                                                                                                                                            returnValue: boolean;
                                                                                                                                                                                                                                                                                                                            shiftKey: boolean;
                                                                                                                                                                                                                                                                                                                            srcElement: null | EventTarget;
                                                                                                                                                                                                                                                                                                                            target: Element;
                                                                                                                                                                                                                                                                                                                            timeStamp: number;
                                                                                                                                                                                                                                                                                                                            type: string;
                                                                                                                                                                                                                                                                                                                            which: number;
                                                                                                                                                                                                                                                                                                                            composedPath(): EventTarget[];
                                                                                                                                                                                                                                                                                                                            initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
                                                                                                                                                                                                                                                                                                                            isDefaultPrevented(): boolean;
                                                                                                                                                                                                                                                                                                                            isImmediatePropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                            isPropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                            preventDefault(): any;
                                                                                                                                                                                                                                                                                                                            stopImmediatePropagation(): void;
                                                                                                                                                                                                                                                                                                                            stopPropagation(): void;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        altKey +AT_TARGET +bubbles +BUBBLING_PHASE +cancelable +cancelBubble +CAPTURING_PHASE +composed +ctrlKey +currentTarget +data +defaultPrevented +delegateTarget +eventPhase +isTrusted +metaKey +namespace +NONE +originalEvent +pageX +pageY +relatedTarget +result +returnValue +shiftKey +srcElement +target +timeStamp +type +which +

                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                        composedPath +initEvent +isDefaultPrevented +isImmediatePropagationStopped +isPropagationStopped +preventDefault +stopImmediatePropagation +stopPropagation +

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        altKey: boolean
                                                                                                                                                                                                                                                                                                                        AT_TARGET: 2
                                                                                                                                                                                                                                                                                                                        bubbles: boolean

                                                                                                                                                                                                                                                                                                                        Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        MDN Reference

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        BUBBLING_PHASE: 3
                                                                                                                                                                                                                                                                                                                        cancelable: boolean

                                                                                                                                                                                                                                                                                                                        Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        MDN Reference

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        cancelBubble: boolean

                                                                                                                                                                                                                                                                                                                        MDN Reference

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        CAPTURING_PHASE: 1
                                                                                                                                                                                                                                                                                                                        composed: boolean

                                                                                                                                                                                                                                                                                                                        Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        MDN Reference

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        ctrlKey: boolean
                                                                                                                                                                                                                                                                                                                        currentTarget: Element

                                                                                                                                                                                                                                                                                                                        The current DOM element within the event bubbling phase.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.currentTarget/">https://api.jquery.com/event.currentTarget/</a>

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        data: any

                                                                                                                                                                                                                                                                                                                        An optional object of data passed to an event method when the current executing handler is bound.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.data/">https://api.jquery.com/event.data/</a>

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        defaultPrevented: boolean

                                                                                                                                                                                                                                                                                                                        Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        MDN Reference

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        delegateTarget: Element

                                                                                                                                                                                                                                                                                                                        The element where the currently-called jQuery event handler was attached.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.delegateTarget/">https://api.jquery.com/event.delegateTarget/</a>

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        eventPhase: number

                                                                                                                                                                                                                                                                                                                        Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        MDN Reference

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        isTrusted: boolean

                                                                                                                                                                                                                                                                                                                        Returns true if event was dispatched by the user agent, and false otherwise.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        MDN Reference

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        metaKey: boolean

                                                                                                                                                                                                                                                                                                                        Indicates whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.metaKey/">https://api.jquery.com/event.metaKey/</a>

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        namespace: string

                                                                                                                                                                                                                                                                                                                        The namespace specified when the event was triggered.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.namespace/">https://api.jquery.com/event.namespace/</a>

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        NONE: 0
                                                                                                                                                                                                                                                                                                                        originalEvent: Event

                                                                                                                                                                                                                                                                                                                        The browser's original Event object.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/category/events/event-object/">https://api.jquery.com/category/events/event-object/</a>

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        pageX: number

                                                                                                                                                                                                                                                                                                                        The mouse position relative to the left edge of the document.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.pageX/">https://api.jquery.com/event.pageX/</a>

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        pageY: number

                                                                                                                                                                                                                                                                                                                        The mouse position relative to the top edge of the document.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.pageY/">https://api.jquery.com/event.pageY/</a>

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        relatedTarget: Element

                                                                                                                                                                                                                                                                                                                        The other DOM element involved in the event, if any.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.relatedTarget/">https://api.jquery.com/event.relatedTarget/</a>

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        result: any

                                                                                                                                                                                                                                                                                                                        The last value returned by an event handler that was triggered by this event, unless the value was undefined.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.result/">https://api.jquery.com/event.result/</a>

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        returnValue: boolean

                                                                                                                                                                                                                                                                                                                        MDN Reference

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        shiftKey: boolean
                                                                                                                                                                                                                                                                                                                        srcElement: null | EventTarget

                                                                                                                                                                                                                                                                                                                        MDN Reference

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        target: Element

                                                                                                                                                                                                                                                                                                                        The DOM element that initiated the event.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.target/">https://api.jquery.com/event.target/</a>

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        timeStamp: number

                                                                                                                                                                                                                                                                                                                        Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        MDN Reference

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        type: string

                                                                                                                                                                                                                                                                                                                        Returns the type of event, e.g. "click", "hashchange", or "submit".

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        MDN Reference

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        which: number

                                                                                                                                                                                                                                                                                                                        For key or mouse events, this property indicates the specific key or button that was pressed.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.which/">https://api.jquery.com/event.which/</a>

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                        • Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          MDN Reference

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Returns EventTarget[]

                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                          • type: string
                                                                                                                                                                                                                                                                                                                          • Optionalbubbles: boolean
                                                                                                                                                                                                                                                                                                                          • Optionalcancelable: boolean

                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                          MDN Reference

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                        • Returns whether event.preventDefault() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.isDefaultPrevented/">https://api.jquery.com/event.isDefaultPrevented/</a>

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                        • Returns whether event.stopImmediatePropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.isImmediatePropagationStopped/">https://api.jquery.com/event.isImmediatePropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                        • Returns whether event.stopPropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.isPropagationStopped/">https://api.jquery.com/event.isPropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                        • If this method is called, the default action of the event will not be triggered.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Returns any

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.preventDefault/">https://api.jquery.com/event.preventDefault/</a>

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                        • Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.stopImmediatePropagation/">https://api.jquery.com/event.stopImmediatePropagation/</a>

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                        • Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.stopPropagation/">https://api.jquery.com/event.stopPropagation/</a>

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryKeyEventObject.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryKeyEventObject.html new file mode 100644 index 000000000..9b76b1fb3 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryKeyEventObject.html @@ -0,0 +1,102 @@ +JQueryKeyEventObject | trilium
                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                          Interface JQueryKeyEventObject

                                                                                                                                                                                                                                                                                                                          ​ Deprecated. Use JQuery.Event.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          interface JQueryKeyEventObject {
                                                                                                                                                                                                                                                                                                                              altKey: boolean;
                                                                                                                                                                                                                                                                                                                              AT_TARGET: 2;
                                                                                                                                                                                                                                                                                                                              bubbles: boolean;
                                                                                                                                                                                                                                                                                                                              BUBBLING_PHASE: 3;
                                                                                                                                                                                                                                                                                                                              cancelable: boolean;
                                                                                                                                                                                                                                                                                                                              cancelBubble: boolean;
                                                                                                                                                                                                                                                                                                                              CAPTURING_PHASE: 1;
                                                                                                                                                                                                                                                                                                                              char: string;
                                                                                                                                                                                                                                                                                                                              charCode: number;
                                                                                                                                                                                                                                                                                                                              composed: boolean;
                                                                                                                                                                                                                                                                                                                              ctrlKey: boolean;
                                                                                                                                                                                                                                                                                                                              currentTarget: Element;
                                                                                                                                                                                                                                                                                                                              data: any;
                                                                                                                                                                                                                                                                                                                              defaultPrevented: boolean;
                                                                                                                                                                                                                                                                                                                              delegateTarget: Element;
                                                                                                                                                                                                                                                                                                                              eventPhase: number;
                                                                                                                                                                                                                                                                                                                              isTrusted: boolean;
                                                                                                                                                                                                                                                                                                                              key: string;
                                                                                                                                                                                                                                                                                                                              keyCode: number;
                                                                                                                                                                                                                                                                                                                              metaKey: boolean;
                                                                                                                                                                                                                                                                                                                              namespace: string;
                                                                                                                                                                                                                                                                                                                              NONE: 0;
                                                                                                                                                                                                                                                                                                                              originalEvent: Event;
                                                                                                                                                                                                                                                                                                                              pageX: number;
                                                                                                                                                                                                                                                                                                                              pageY: number;
                                                                                                                                                                                                                                                                                                                              relatedTarget: Element;
                                                                                                                                                                                                                                                                                                                              result: any;
                                                                                                                                                                                                                                                                                                                              returnValue: boolean;
                                                                                                                                                                                                                                                                                                                              shiftKey: boolean;
                                                                                                                                                                                                                                                                                                                              srcElement: null | EventTarget;
                                                                                                                                                                                                                                                                                                                              target: Element;
                                                                                                                                                                                                                                                                                                                              timeStamp: number;
                                                                                                                                                                                                                                                                                                                              type: string;
                                                                                                                                                                                                                                                                                                                              which: number;
                                                                                                                                                                                                                                                                                                                              composedPath(): EventTarget[];
                                                                                                                                                                                                                                                                                                                              initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
                                                                                                                                                                                                                                                                                                                              isDefaultPrevented(): boolean;
                                                                                                                                                                                                                                                                                                                              isImmediatePropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                              isPropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                              preventDefault(): any;
                                                                                                                                                                                                                                                                                                                              stopImmediatePropagation(): void;
                                                                                                                                                                                                                                                                                                                              stopPropagation(): void;
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                          altKey +AT_TARGET +bubbles +BUBBLING_PHASE +cancelable +cancelBubble +CAPTURING_PHASE +char +charCode +composed +ctrlKey +currentTarget +data +defaultPrevented +delegateTarget +eventPhase +isTrusted +key +keyCode +metaKey +namespace +NONE +originalEvent +pageX +pageY +relatedTarget +result +returnValue +shiftKey +srcElement +target +timeStamp +type +which +

                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                          composedPath +initEvent +isDefaultPrevented +isImmediatePropagationStopped +isPropagationStopped +preventDefault +stopImmediatePropagation +stopPropagation +

                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                          altKey: boolean
                                                                                                                                                                                                                                                                                                                          AT_TARGET: 2
                                                                                                                                                                                                                                                                                                                          bubbles: boolean

                                                                                                                                                                                                                                                                                                                          Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          MDN Reference

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          BUBBLING_PHASE: 3
                                                                                                                                                                                                                                                                                                                          cancelable: boolean

                                                                                                                                                                                                                                                                                                                          Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          MDN Reference

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          cancelBubble: boolean

                                                                                                                                                                                                                                                                                                                          MDN Reference

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          CAPTURING_PHASE: 1
                                                                                                                                                                                                                                                                                                                          char: string
                                                                                                                                                                                                                                                                                                                          charCode: number
                                                                                                                                                                                                                                                                                                                          composed: boolean

                                                                                                                                                                                                                                                                                                                          Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          MDN Reference

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          ctrlKey: boolean
                                                                                                                                                                                                                                                                                                                          currentTarget: Element

                                                                                                                                                                                                                                                                                                                          The current DOM element within the event bubbling phase.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.currentTarget/">https://api.jquery.com/event.currentTarget/</a>

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          data: any

                                                                                                                                                                                                                                                                                                                          An optional object of data passed to an event method when the current executing handler is bound.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.data/">https://api.jquery.com/event.data/</a>

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          defaultPrevented: boolean

                                                                                                                                                                                                                                                                                                                          Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          MDN Reference

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          delegateTarget: Element

                                                                                                                                                                                                                                                                                                                          The element where the currently-called jQuery event handler was attached.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.delegateTarget/">https://api.jquery.com/event.delegateTarget/</a>

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          eventPhase: number

                                                                                                                                                                                                                                                                                                                          Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          MDN Reference

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          isTrusted: boolean

                                                                                                                                                                                                                                                                                                                          Returns true if event was dispatched by the user agent, and false otherwise.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          MDN Reference

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          key: string
                                                                                                                                                                                                                                                                                                                          keyCode: number
                                                                                                                                                                                                                                                                                                                          metaKey: boolean

                                                                                                                                                                                                                                                                                                                          Indicates whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.metaKey/">https://api.jquery.com/event.metaKey/</a>

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          namespace: string

                                                                                                                                                                                                                                                                                                                          The namespace specified when the event was triggered.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.namespace/">https://api.jquery.com/event.namespace/</a>

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          NONE: 0
                                                                                                                                                                                                                                                                                                                          originalEvent: Event

                                                                                                                                                                                                                                                                                                                          The browser's original Event object.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/category/events/event-object/">https://api.jquery.com/category/events/event-object/</a>

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          pageX: number

                                                                                                                                                                                                                                                                                                                          The mouse position relative to the left edge of the document.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.pageX/">https://api.jquery.com/event.pageX/</a>

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          pageY: number

                                                                                                                                                                                                                                                                                                                          The mouse position relative to the top edge of the document.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.pageY/">https://api.jquery.com/event.pageY/</a>

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          relatedTarget: Element

                                                                                                                                                                                                                                                                                                                          The other DOM element involved in the event, if any.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.relatedTarget/">https://api.jquery.com/event.relatedTarget/</a>

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          result: any

                                                                                                                                                                                                                                                                                                                          The last value returned by an event handler that was triggered by this event, unless the value was undefined.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.result/">https://api.jquery.com/event.result/</a>

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          returnValue: boolean

                                                                                                                                                                                                                                                                                                                          MDN Reference

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          shiftKey: boolean
                                                                                                                                                                                                                                                                                                                          srcElement: null | EventTarget

                                                                                                                                                                                                                                                                                                                          MDN Reference

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          target: Element

                                                                                                                                                                                                                                                                                                                          The DOM element that initiated the event.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.target/">https://api.jquery.com/event.target/</a>

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          timeStamp: number

                                                                                                                                                                                                                                                                                                                          Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          MDN Reference

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          type: string

                                                                                                                                                                                                                                                                                                                          Returns the type of event, e.g. "click", "hashchange", or "submit".

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          MDN Reference

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          which: number

                                                                                                                                                                                                                                                                                                                          For key or mouse events, this property indicates the specific key or button that was pressed.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.which/">https://api.jquery.com/event.which/</a>

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                          • Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Returns EventTarget[]

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • type: string
                                                                                                                                                                                                                                                                                                                            • Optionalbubbles: boolean
                                                                                                                                                                                                                                                                                                                            • Optionalcancelable: boolean

                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                          • Returns whether event.preventDefault() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.isDefaultPrevented/">https://api.jquery.com/event.isDefaultPrevented/</a>

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                          • Returns whether event.stopImmediatePropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.isImmediatePropagationStopped/">https://api.jquery.com/event.isImmediatePropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                          • Returns whether event.stopPropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.isPropagationStopped/">https://api.jquery.com/event.isPropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                          • If this method is called, the default action of the event will not be triggered.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Returns any

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.preventDefault/">https://api.jquery.com/event.preventDefault/</a>

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                          • Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.stopImmediatePropagation/">https://api.jquery.com/event.stopImmediatePropagation/</a>

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                          • Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.stopPropagation/">https://api.jquery.com/event.stopPropagation/</a>

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryMouseEventObject.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryMouseEventObject.html new file mode 100644 index 000000000..6fc259f74 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryMouseEventObject.html @@ -0,0 +1,105 @@ +JQueryMouseEventObject | trilium
                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                            Interface JQueryMouseEventObject

                                                                                                                                                                                                                                                                                                                            ​ Deprecated. Use JQuery.Event.

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            interface JQueryMouseEventObject {
                                                                                                                                                                                                                                                                                                                                altKey: boolean;
                                                                                                                                                                                                                                                                                                                                AT_TARGET: 2;
                                                                                                                                                                                                                                                                                                                                bubbles: boolean;
                                                                                                                                                                                                                                                                                                                                BUBBLING_PHASE: 3;
                                                                                                                                                                                                                                                                                                                                button: number;
                                                                                                                                                                                                                                                                                                                                cancelable: boolean;
                                                                                                                                                                                                                                                                                                                                cancelBubble: boolean;
                                                                                                                                                                                                                                                                                                                                CAPTURING_PHASE: 1;
                                                                                                                                                                                                                                                                                                                                clientX: number;
                                                                                                                                                                                                                                                                                                                                clientY: number;
                                                                                                                                                                                                                                                                                                                                composed: boolean;
                                                                                                                                                                                                                                                                                                                                ctrlKey: boolean;
                                                                                                                                                                                                                                                                                                                                currentTarget: Element;
                                                                                                                                                                                                                                                                                                                                data: any;
                                                                                                                                                                                                                                                                                                                                defaultPrevented: boolean;
                                                                                                                                                                                                                                                                                                                                delegateTarget: Element;
                                                                                                                                                                                                                                                                                                                                eventPhase: number;
                                                                                                                                                                                                                                                                                                                                isTrusted: boolean;
                                                                                                                                                                                                                                                                                                                                metaKey: boolean;
                                                                                                                                                                                                                                                                                                                                namespace: string;
                                                                                                                                                                                                                                                                                                                                NONE: 0;
                                                                                                                                                                                                                                                                                                                                offsetX: number;
                                                                                                                                                                                                                                                                                                                                offsetY: number;
                                                                                                                                                                                                                                                                                                                                originalEvent: Event;
                                                                                                                                                                                                                                                                                                                                pageX: number;
                                                                                                                                                                                                                                                                                                                                pageY: number;
                                                                                                                                                                                                                                                                                                                                relatedTarget: Element;
                                                                                                                                                                                                                                                                                                                                result: any;
                                                                                                                                                                                                                                                                                                                                returnValue: boolean;
                                                                                                                                                                                                                                                                                                                                screenX: number;
                                                                                                                                                                                                                                                                                                                                screenY: number;
                                                                                                                                                                                                                                                                                                                                shiftKey: boolean;
                                                                                                                                                                                                                                                                                                                                srcElement: null | EventTarget;
                                                                                                                                                                                                                                                                                                                                target: Element;
                                                                                                                                                                                                                                                                                                                                timeStamp: number;
                                                                                                                                                                                                                                                                                                                                type: string;
                                                                                                                                                                                                                                                                                                                                which: number;
                                                                                                                                                                                                                                                                                                                                composedPath(): EventTarget[];
                                                                                                                                                                                                                                                                                                                                initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
                                                                                                                                                                                                                                                                                                                                isDefaultPrevented(): boolean;
                                                                                                                                                                                                                                                                                                                                isImmediatePropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                                isPropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                                preventDefault(): any;
                                                                                                                                                                                                                                                                                                                                stopImmediatePropagation(): void;
                                                                                                                                                                                                                                                                                                                                stopPropagation(): void;
                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                            altKey +AT_TARGET +bubbles +BUBBLING_PHASE +button +cancelable +cancelBubble +CAPTURING_PHASE +clientX +clientY +composed +ctrlKey +currentTarget +data +defaultPrevented +delegateTarget +eventPhase +isTrusted +metaKey +namespace +NONE +offsetX +offsetY +originalEvent +pageX +pageY +relatedTarget +result +returnValue +screenX +screenY +shiftKey +srcElement +target +timeStamp +type +which +

                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                            composedPath +initEvent +isDefaultPrevented +isImmediatePropagationStopped +isPropagationStopped +preventDefault +stopImmediatePropagation +stopPropagation +

                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                            altKey: boolean
                                                                                                                                                                                                                                                                                                                            AT_TARGET: 2
                                                                                                                                                                                                                                                                                                                            bubbles: boolean

                                                                                                                                                                                                                                                                                                                            Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            BUBBLING_PHASE: 3
                                                                                                                                                                                                                                                                                                                            button: number
                                                                                                                                                                                                                                                                                                                            cancelable: boolean

                                                                                                                                                                                                                                                                                                                            Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            cancelBubble: boolean

                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            CAPTURING_PHASE: 1
                                                                                                                                                                                                                                                                                                                            clientX: number
                                                                                                                                                                                                                                                                                                                            clientY: number
                                                                                                                                                                                                                                                                                                                            composed: boolean

                                                                                                                                                                                                                                                                                                                            Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            ctrlKey: boolean
                                                                                                                                                                                                                                                                                                                            currentTarget: Element

                                                                                                                                                                                                                                                                                                                            The current DOM element within the event bubbling phase.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.currentTarget/">https://api.jquery.com/event.currentTarget/</a>

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            data: any

                                                                                                                                                                                                                                                                                                                            An optional object of data passed to an event method when the current executing handler is bound.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.data/">https://api.jquery.com/event.data/</a>

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            defaultPrevented: boolean

                                                                                                                                                                                                                                                                                                                            Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            delegateTarget: Element

                                                                                                                                                                                                                                                                                                                            The element where the currently-called jQuery event handler was attached.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.delegateTarget/">https://api.jquery.com/event.delegateTarget/</a>

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            eventPhase: number

                                                                                                                                                                                                                                                                                                                            Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            isTrusted: boolean

                                                                                                                                                                                                                                                                                                                            Returns true if event was dispatched by the user agent, and false otherwise.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            metaKey: boolean

                                                                                                                                                                                                                                                                                                                            Indicates whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.metaKey/">https://api.jquery.com/event.metaKey/</a>

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            namespace: string

                                                                                                                                                                                                                                                                                                                            The namespace specified when the event was triggered.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.namespace/">https://api.jquery.com/event.namespace/</a>

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            NONE: 0
                                                                                                                                                                                                                                                                                                                            offsetX: number
                                                                                                                                                                                                                                                                                                                            offsetY: number
                                                                                                                                                                                                                                                                                                                            originalEvent: Event

                                                                                                                                                                                                                                                                                                                            The browser's original Event object.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/category/events/event-object/">https://api.jquery.com/category/events/event-object/</a>

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            pageX: number

                                                                                                                                                                                                                                                                                                                            The mouse position relative to the left edge of the document.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.pageX/">https://api.jquery.com/event.pageX/</a>

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            pageY: number

                                                                                                                                                                                                                                                                                                                            The mouse position relative to the top edge of the document.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.pageY/">https://api.jquery.com/event.pageY/</a>

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            relatedTarget: Element

                                                                                                                                                                                                                                                                                                                            The other DOM element involved in the event, if any.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.relatedTarget/">https://api.jquery.com/event.relatedTarget/</a>

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            result: any

                                                                                                                                                                                                                                                                                                                            The last value returned by an event handler that was triggered by this event, unless the value was undefined.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.result/">https://api.jquery.com/event.result/</a>

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            returnValue: boolean

                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            screenX: number
                                                                                                                                                                                                                                                                                                                            screenY: number
                                                                                                                                                                                                                                                                                                                            shiftKey: boolean
                                                                                                                                                                                                                                                                                                                            srcElement: null | EventTarget

                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            target: Element

                                                                                                                                                                                                                                                                                                                            The DOM element that initiated the event.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.target/">https://api.jquery.com/event.target/</a>

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            timeStamp: number

                                                                                                                                                                                                                                                                                                                            Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            type: string

                                                                                                                                                                                                                                                                                                                            Returns the type of event, e.g. "click", "hashchange", or "submit".

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            which: number

                                                                                                                                                                                                                                                                                                                            For key or mouse events, this property indicates the specific key or button that was pressed.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.which/">https://api.jquery.com/event.which/</a>

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                            • Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              MDN Reference

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Returns EventTarget[]

                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                              • type: string
                                                                                                                                                                                                                                                                                                                              • Optionalbubbles: boolean
                                                                                                                                                                                                                                                                                                                              • Optionalcancelable: boolean

                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                              MDN Reference

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                            • Returns whether event.preventDefault() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/event.isDefaultPrevented/">https://api.jquery.com/event.isDefaultPrevented/</a>

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                            • Returns whether event.stopImmediatePropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/event.isImmediatePropagationStopped/">https://api.jquery.com/event.isImmediatePropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                            • Returns whether event.stopPropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/event.isPropagationStopped/">https://api.jquery.com/event.isPropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                            • If this method is called, the default action of the event will not be triggered.

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Returns any

                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/event.preventDefault/">https://api.jquery.com/event.preventDefault/</a>

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                            • Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/event.stopImmediatePropagation/">https://api.jquery.com/event.stopImmediatePropagation/</a>

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                            • Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/event.stopPropagation/">https://api.jquery.com/event.stopPropagation/</a>

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryPromise.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryPromise.html new file mode 100644 index 000000000..b3a9c74fb --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.JQueryPromise.html @@ -0,0 +1,443 @@ +JQueryPromise | trilium
                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                              Interface JQueryPromise<T>

                                                                                                                                                                                                                                                                                                                              This object provides a subset of the methods of the Deferred object (then, done, fail, always, pipe, progress, state and promise) to prevent users from changing the state of the Deferred.

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/Types/#Promise">https://api.jquery.com/Types/#Promise</a>

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              interface JQueryPromise<T> {
                                                                                                                                                                                                                                                                                                                                  always(
                                                                                                                                                                                                                                                                                                                                      alwaysCallback: TypeOrArray<CallbackBase<any, any, any, any>>,
                                                                                                                                                                                                                                                                                                                                      ...alwaysCallbacks: TypeOrArray<CallbackBase<any, any, any, any>>[],
                                                                                                                                                                                                                                                                                                                                  ): this;
                                                                                                                                                                                                                                                                                                                                  catch<
                                                                                                                                                                                                                                                                                                                                      ARF = never,
                                                                                                                                                                                                                                                                                                                                      AJF = never,
                                                                                                                                                                                                                                                                                                                                      ANF = never,
                                                                                                                                                                                                                                                                                                                                      BRF = never,
                                                                                                                                                                                                                                                                                                                                      BJF = never,
                                                                                                                                                                                                                                                                                                                                      BNF = never,
                                                                                                                                                                                                                                                                                                                                      CRF = never,
                                                                                                                                                                                                                                                                                                                                      CJF = never,
                                                                                                                                                                                                                                                                                                                                      CNF = never,
                                                                                                                                                                                                                                                                                                                                      RRF = never,
                                                                                                                                                                                                                                                                                                                                      RJF = never,
                                                                                                                                                                                                                                                                                                                                      RNF = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      failFilter?:
                                                                                                                                                                                                                                                                                                                                          | null
                                                                                                                                                                                                                                                                                                                                          | (
                                                                                                                                                                                                                                                                                                                                              (
                                                                                                                                                                                                                                                                                                                                                  t: any,
                                                                                                                                                                                                                                                                                                                                                  u: any,
                                                                                                                                                                                                                                                                                                                                                  v: any,
                                                                                                                                                                                                                                                                                                                                                  ...s: any[],
                                                                                                                                                                                                                                                                                                                                              ) =>
                                                                                                                                                                                                                                                                                                                                                  | ARF
                                                                                                                                                                                                                                                                                                                                                  | PromiseBase<
                                                                                                                                                                                                                                                                                                                                                      ARF,
                                                                                                                                                                                                                                                                                                                                                      AJF,
                                                                                                                                                                                                                                                                                                                                                      ANF,
                                                                                                                                                                                                                                                                                                                                                      BRF,
                                                                                                                                                                                                                                                                                                                                                      BJF,
                                                                                                                                                                                                                                                                                                                                                      BNF,
                                                                                                                                                                                                                                                                                                                                                      CRF,
                                                                                                                                                                                                                                                                                                                                                      CJF,
                                                                                                                                                                                                                                                                                                                                                      CNF,
                                                                                                                                                                                                                                                                                                                                                      RRF,
                                                                                                                                                                                                                                                                                                                                                      RJF,
                                                                                                                                                                                                                                                                                                                                                      RNF,
                                                                                                                                                                                                                                                                                                                                                  >
                                                                                                                                                                                                                                                                                                                                                  | Thenable<ARF>
                                                                                                                                                                                                                                                                                                                                          ),
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>;
                                                                                                                                                                                                                                                                                                                                  done(
                                                                                                                                                                                                                                                                                                                                      doneCallback: TypeOrArray<CallbackBase<T, T, T, T>>,
                                                                                                                                                                                                                                                                                                                                      ...doneCallbacks: TypeOrArray<CallbackBase<T, T, T, T>>[],
                                                                                                                                                                                                                                                                                                                                  ): this;
                                                                                                                                                                                                                                                                                                                                  fail(
                                                                                                                                                                                                                                                                                                                                      failCallback: TypeOrArray<CallbackBase<any, any, any, any>>,
                                                                                                                                                                                                                                                                                                                                      ...failCallbacks: TypeOrArray<CallbackBase<any, any, any, any>>[],
                                                                                                                                                                                                                                                                                                                                  ): this;
                                                                                                                                                                                                                                                                                                                                  pipe<
                                                                                                                                                                                                                                                                                                                                      ARD = never,
                                                                                                                                                                                                                                                                                                                                      AJD = never,
                                                                                                                                                                                                                                                                                                                                      AND = never,
                                                                                                                                                                                                                                                                                                                                      BRD = never,
                                                                                                                                                                                                                                                                                                                                      BJD = never,
                                                                                                                                                                                                                                                                                                                                      BND = never,
                                                                                                                                                                                                                                                                                                                                      CRD = never,
                                                                                                                                                                                                                                                                                                                                      CJD = never,
                                                                                                                                                                                                                                                                                                                                      CND = never,
                                                                                                                                                                                                                                                                                                                                      RRD = never,
                                                                                                                                                                                                                                                                                                                                      RJD = never,
                                                                                                                                                                                                                                                                                                                                      RND = never,
                                                                                                                                                                                                                                                                                                                                      ARF = never,
                                                                                                                                                                                                                                                                                                                                      AJF = never,
                                                                                                                                                                                                                                                                                                                                      ANF = never,
                                                                                                                                                                                                                                                                                                                                      BRF = never,
                                                                                                                                                                                                                                                                                                                                      BJF = never,
                                                                                                                                                                                                                                                                                                                                      BNF = never,
                                                                                                                                                                                                                                                                                                                                      CRF = never,
                                                                                                                                                                                                                                                                                                                                      CJF = never,
                                                                                                                                                                                                                                                                                                                                      CNF = never,
                                                                                                                                                                                                                                                                                                                                      RRF = never,
                                                                                                                                                                                                                                                                                                                                      RJF = never,
                                                                                                                                                                                                                                                                                                                                      RNF = never,
                                                                                                                                                                                                                                                                                                                                      ARP = never,
                                                                                                                                                                                                                                                                                                                                      AJP = never,
                                                                                                                                                                                                                                                                                                                                      ANP = never,
                                                                                                                                                                                                                                                                                                                                      BRP = never,
                                                                                                                                                                                                                                                                                                                                      BJP = never,
                                                                                                                                                                                                                                                                                                                                      BNP = never,
                                                                                                                                                                                                                                                                                                                                      CRP = never,
                                                                                                                                                                                                                                                                                                                                      CJP = never,
                                                                                                                                                                                                                                                                                                                                      CNP = never,
                                                                                                                                                                                                                                                                                                                                      RRP = never,
                                                                                                                                                                                                                                                                                                                                      RJP = never,
                                                                                                                                                                                                                                                                                                                                      RNP = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      doneFilter: (
                                                                                                                                                                                                                                                                                                                                          t: T,
                                                                                                                                                                                                                                                                                                                                          u: T,
                                                                                                                                                                                                                                                                                                                                          v: T,
                                                                                                                                                                                                                                                                                                                                          ...s: T[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ARD
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                      failFilter: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | AJF
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                          | Thenable<AJF>,
                                                                                                                                                                                                                                                                                                                                      progressFilter: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ANP
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                      ARD
                                                                                                                                                                                                                                                                                                                                      | ARF
                                                                                                                                                                                                                                                                                                                                      | ARP,
                                                                                                                                                                                                                                                                                                                                      AJD | AJF | AJP,
                                                                                                                                                                                                                                                                                                                                      AND | ANF | ANP,
                                                                                                                                                                                                                                                                                                                                      BRD | BRF | BRP,
                                                                                                                                                                                                                                                                                                                                      BJD | BJF | BJP,
                                                                                                                                                                                                                                                                                                                                      BND | BNF | BNP,
                                                                                                                                                                                                                                                                                                                                      CRD | CRF | CRP,
                                                                                                                                                                                                                                                                                                                                      CJD | CJF | CJP,
                                                                                                                                                                                                                                                                                                                                      CND | CNF | CNP,
                                                                                                                                                                                                                                                                                                                                      RRD | RRF | RRP,
                                                                                                                                                                                                                                                                                                                                      RJD | RJF | RJP,
                                                                                                                                                                                                                                                                                                                                      RND | RNF | RNP,
                                                                                                                                                                                                                                                                                                                                  >;
                                                                                                                                                                                                                                                                                                                                  pipe<
                                                                                                                                                                                                                                                                                                                                      ARF = never,
                                                                                                                                                                                                                                                                                                                                      AJF = never,
                                                                                                                                                                                                                                                                                                                                      ANF = never,
                                                                                                                                                                                                                                                                                                                                      BRF = never,
                                                                                                                                                                                                                                                                                                                                      BJF = never,
                                                                                                                                                                                                                                                                                                                                      BNF = never,
                                                                                                                                                                                                                                                                                                                                      CRF = never,
                                                                                                                                                                                                                                                                                                                                      CJF = never,
                                                                                                                                                                                                                                                                                                                                      CNF = never,
                                                                                                                                                                                                                                                                                                                                      RRF = never,
                                                                                                                                                                                                                                                                                                                                      RJF = never,
                                                                                                                                                                                                                                                                                                                                      RNF = never,
                                                                                                                                                                                                                                                                                                                                      ARP = never,
                                                                                                                                                                                                                                                                                                                                      AJP = never,
                                                                                                                                                                                                                                                                                                                                      ANP = never,
                                                                                                                                                                                                                                                                                                                                      BRP = never,
                                                                                                                                                                                                                                                                                                                                      BJP = never,
                                                                                                                                                                                                                                                                                                                                      BNP = never,
                                                                                                                                                                                                                                                                                                                                      CRP = never,
                                                                                                                                                                                                                                                                                                                                      CJP = never,
                                                                                                                                                                                                                                                                                                                                      CNP = never,
                                                                                                                                                                                                                                                                                                                                      RRP = never,
                                                                                                                                                                                                                                                                                                                                      RJP = never,
                                                                                                                                                                                                                                                                                                                                      RNP = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      doneFilter: null,
                                                                                                                                                                                                                                                                                                                                      failFilter: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | AJF
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                          | Thenable<AJF>,
                                                                                                                                                                                                                                                                                                                                      progressFilter: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ANP
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                      ARF
                                                                                                                                                                                                                                                                                                                                      | ARP,
                                                                                                                                                                                                                                                                                                                                      AJF | AJP,
                                                                                                                                                                                                                                                                                                                                      ANF | ANP,
                                                                                                                                                                                                                                                                                                                                      BRF | BRP,
                                                                                                                                                                                                                                                                                                                                      BJF | BJP,
                                                                                                                                                                                                                                                                                                                                      BNF | BNP,
                                                                                                                                                                                                                                                                                                                                      CRF | CRP,
                                                                                                                                                                                                                                                                                                                                      CJF | CJP,
                                                                                                                                                                                                                                                                                                                                      CNF | CNP,
                                                                                                                                                                                                                                                                                                                                      RRF | RRP,
                                                                                                                                                                                                                                                                                                                                      RJF | RJP,
                                                                                                                                                                                                                                                                                                                                      RNF | RNP,
                                                                                                                                                                                                                                                                                                                                  >;
                                                                                                                                                                                                                                                                                                                                  pipe<
                                                                                                                                                                                                                                                                                                                                      ARD = never,
                                                                                                                                                                                                                                                                                                                                      AJD = never,
                                                                                                                                                                                                                                                                                                                                      AND = never,
                                                                                                                                                                                                                                                                                                                                      BRD = never,
                                                                                                                                                                                                                                                                                                                                      BJD = never,
                                                                                                                                                                                                                                                                                                                                      BND = never,
                                                                                                                                                                                                                                                                                                                                      CRD = never,
                                                                                                                                                                                                                                                                                                                                      CJD = never,
                                                                                                                                                                                                                                                                                                                                      CND = never,
                                                                                                                                                                                                                                                                                                                                      RRD = never,
                                                                                                                                                                                                                                                                                                                                      RJD = never,
                                                                                                                                                                                                                                                                                                                                      RND = never,
                                                                                                                                                                                                                                                                                                                                      ARP = never,
                                                                                                                                                                                                                                                                                                                                      AJP = never,
                                                                                                                                                                                                                                                                                                                                      ANP = never,
                                                                                                                                                                                                                                                                                                                                      BRP = never,
                                                                                                                                                                                                                                                                                                                                      BJP = never,
                                                                                                                                                                                                                                                                                                                                      BNP = never,
                                                                                                                                                                                                                                                                                                                                      CRP = never,
                                                                                                                                                                                                                                                                                                                                      CJP = never,
                                                                                                                                                                                                                                                                                                                                      CNP = never,
                                                                                                                                                                                                                                                                                                                                      RRP = never,
                                                                                                                                                                                                                                                                                                                                      RJP = never,
                                                                                                                                                                                                                                                                                                                                      RNP = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      doneFilter: (
                                                                                                                                                                                                                                                                                                                                          t: T,
                                                                                                                                                                                                                                                                                                                                          u: T,
                                                                                                                                                                                                                                                                                                                                          v: T,
                                                                                                                                                                                                                                                                                                                                          ...s: T[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ARD
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                      failFilter: null,
                                                                                                                                                                                                                                                                                                                                      progressFilter: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ANP
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                      ARD
                                                                                                                                                                                                                                                                                                                                      | ARP,
                                                                                                                                                                                                                                                                                                                                      AJD | AJP,
                                                                                                                                                                                                                                                                                                                                      AND | ANP,
                                                                                                                                                                                                                                                                                                                                      BRD | BRP,
                                                                                                                                                                                                                                                                                                                                      BJD | BJP,
                                                                                                                                                                                                                                                                                                                                      BND | BNP,
                                                                                                                                                                                                                                                                                                                                      CRD | CRP,
                                                                                                                                                                                                                                                                                                                                      CJD | CJP,
                                                                                                                                                                                                                                                                                                                                      CND | CNP,
                                                                                                                                                                                                                                                                                                                                      RRD | RRP,
                                                                                                                                                                                                                                                                                                                                      RJD | RJP,
                                                                                                                                                                                                                                                                                                                                      RND | RNP,
                                                                                                                                                                                                                                                                                                                                  >;
                                                                                                                                                                                                                                                                                                                                  pipe<
                                                                                                                                                                                                                                                                                                                                      ARP = never,
                                                                                                                                                                                                                                                                                                                                      AJP = never,
                                                                                                                                                                                                                                                                                                                                      ANP = never,
                                                                                                                                                                                                                                                                                                                                      BRP = never,
                                                                                                                                                                                                                                                                                                                                      BJP = never,
                                                                                                                                                                                                                                                                                                                                      BNP = never,
                                                                                                                                                                                                                                                                                                                                      CRP = never,
                                                                                                                                                                                                                                                                                                                                      CJP = never,
                                                                                                                                                                                                                                                                                                                                      CNP = never,
                                                                                                                                                                                                                                                                                                                                      RRP = never,
                                                                                                                                                                                                                                                                                                                                      RJP = never,
                                                                                                                                                                                                                                                                                                                                      RNP = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      doneFilter: null,
                                                                                                                                                                                                                                                                                                                                      failFilter: null,
                                                                                                                                                                                                                                                                                                                                      progressFilter?: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ANP
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>;
                                                                                                                                                                                                                                                                                                                                  pipe<
                                                                                                                                                                                                                                                                                                                                      ARD = never,
                                                                                                                                                                                                                                                                                                                                      AJD = never,
                                                                                                                                                                                                                                                                                                                                      AND = never,
                                                                                                                                                                                                                                                                                                                                      BRD = never,
                                                                                                                                                                                                                                                                                                                                      BJD = never,
                                                                                                                                                                                                                                                                                                                                      BND = never,
                                                                                                                                                                                                                                                                                                                                      CRD = never,
                                                                                                                                                                                                                                                                                                                                      CJD = never,
                                                                                                                                                                                                                                                                                                                                      CND = never,
                                                                                                                                                                                                                                                                                                                                      RRD = never,
                                                                                                                                                                                                                                                                                                                                      RJD = never,
                                                                                                                                                                                                                                                                                                                                      RND = never,
                                                                                                                                                                                                                                                                                                                                      ARF = never,
                                                                                                                                                                                                                                                                                                                                      AJF = never,
                                                                                                                                                                                                                                                                                                                                      ANF = never,
                                                                                                                                                                                                                                                                                                                                      BRF = never,
                                                                                                                                                                                                                                                                                                                                      BJF = never,
                                                                                                                                                                                                                                                                                                                                      BNF = never,
                                                                                                                                                                                                                                                                                                                                      CRF = never,
                                                                                                                                                                                                                                                                                                                                      CJF = never,
                                                                                                                                                                                                                                                                                                                                      CNF = never,
                                                                                                                                                                                                                                                                                                                                      RRF = never,
                                                                                                                                                                                                                                                                                                                                      RJF = never,
                                                                                                                                                                                                                                                                                                                                      RNF = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      doneFilter: (
                                                                                                                                                                                                                                                                                                                                          t: T,
                                                                                                                                                                                                                                                                                                                                          u: T,
                                                                                                                                                                                                                                                                                                                                          v: T,
                                                                                                                                                                                                                                                                                                                                          ...s: T[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ARD
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                      failFilter: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | AJF
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                          | Thenable<AJF>,
                                                                                                                                                                                                                                                                                                                                      progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                      ARD
                                                                                                                                                                                                                                                                                                                                      | ARF,
                                                                                                                                                                                                                                                                                                                                      AJD | AJF,
                                                                                                                                                                                                                                                                                                                                      AND | ANF,
                                                                                                                                                                                                                                                                                                                                      BRD | BRF,
                                                                                                                                                                                                                                                                                                                                      BJD | BJF,
                                                                                                                                                                                                                                                                                                                                      BND | BNF,
                                                                                                                                                                                                                                                                                                                                      CRD | CRF,
                                                                                                                                                                                                                                                                                                                                      CJD | CJF,
                                                                                                                                                                                                                                                                                                                                      CND | CNF,
                                                                                                                                                                                                                                                                                                                                      RRD | RRF,
                                                                                                                                                                                                                                                                                                                                      RJD | RJF,
                                                                                                                                                                                                                                                                                                                                      RND | RNF,
                                                                                                                                                                                                                                                                                                                                  >;
                                                                                                                                                                                                                                                                                                                                  pipe<
                                                                                                                                                                                                                                                                                                                                      ARF = never,
                                                                                                                                                                                                                                                                                                                                      AJF = never,
                                                                                                                                                                                                                                                                                                                                      ANF = never,
                                                                                                                                                                                                                                                                                                                                      BRF = never,
                                                                                                                                                                                                                                                                                                                                      BJF = never,
                                                                                                                                                                                                                                                                                                                                      BNF = never,
                                                                                                                                                                                                                                                                                                                                      CRF = never,
                                                                                                                                                                                                                                                                                                                                      CJF = never,
                                                                                                                                                                                                                                                                                                                                      CNF = never,
                                                                                                                                                                                                                                                                                                                                      RRF = never,
                                                                                                                                                                                                                                                                                                                                      RJF = never,
                                                                                                                                                                                                                                                                                                                                      RNF = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      doneFilter: null,
                                                                                                                                                                                                                                                                                                                                      failFilter: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | AJF
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                          | Thenable<AJF>,
                                                                                                                                                                                                                                                                                                                                      progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>;
                                                                                                                                                                                                                                                                                                                                  pipe<
                                                                                                                                                                                                                                                                                                                                      ARD = never,
                                                                                                                                                                                                                                                                                                                                      AJD = never,
                                                                                                                                                                                                                                                                                                                                      AND = never,
                                                                                                                                                                                                                                                                                                                                      BRD = never,
                                                                                                                                                                                                                                                                                                                                      BJD = never,
                                                                                                                                                                                                                                                                                                                                      BND = never,
                                                                                                                                                                                                                                                                                                                                      CRD = never,
                                                                                                                                                                                                                                                                                                                                      CJD = never,
                                                                                                                                                                                                                                                                                                                                      CND = never,
                                                                                                                                                                                                                                                                                                                                      RRD = never,
                                                                                                                                                                                                                                                                                                                                      RJD = never,
                                                                                                                                                                                                                                                                                                                                      RND = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      doneFilter: (
                                                                                                                                                                                                                                                                                                                                          t: T,
                                                                                                                                                                                                                                                                                                                                          u: T,
                                                                                                                                                                                                                                                                                                                                          v: T,
                                                                                                                                                                                                                                                                                                                                          ...s: T[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ARD
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                      failFilter?: null,
                                                                                                                                                                                                                                                                                                                                      progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>;
                                                                                                                                                                                                                                                                                                                                  progress(
                                                                                                                                                                                                                                                                                                                                      progressCallback: TypeOrArray<CallbackBase<any, any, any, any>>,
                                                                                                                                                                                                                                                                                                                                      ...progressCallbacks: TypeOrArray<CallbackBase<any, any, any, any>>[],
                                                                                                                                                                                                                                                                                                                                  ): this;
                                                                                                                                                                                                                                                                                                                                  promise<TTarget extends object>(
                                                                                                                                                                                                                                                                                                                                      target: TTarget,
                                                                                                                                                                                                                                                                                                                                  ): JQueryPromise<T> & TTarget;
                                                                                                                                                                                                                                                                                                                                  promise(): this;
                                                                                                                                                                                                                                                                                                                                  state(): "pending" | "resolved" | "rejected";
                                                                                                                                                                                                                                                                                                                                  then<
                                                                                                                                                                                                                                                                                                                                      ARD = never,
                                                                                                                                                                                                                                                                                                                                      AJD = never,
                                                                                                                                                                                                                                                                                                                                      AND = never,
                                                                                                                                                                                                                                                                                                                                      BRD = never,
                                                                                                                                                                                                                                                                                                                                      BJD = never,
                                                                                                                                                                                                                                                                                                                                      BND = never,
                                                                                                                                                                                                                                                                                                                                      CRD = never,
                                                                                                                                                                                                                                                                                                                                      CJD = never,
                                                                                                                                                                                                                                                                                                                                      CND = never,
                                                                                                                                                                                                                                                                                                                                      RRD = never,
                                                                                                                                                                                                                                                                                                                                      RJD = never,
                                                                                                                                                                                                                                                                                                                                      RND = never,
                                                                                                                                                                                                                                                                                                                                      ARF = never,
                                                                                                                                                                                                                                                                                                                                      AJF = never,
                                                                                                                                                                                                                                                                                                                                      ANF = never,
                                                                                                                                                                                                                                                                                                                                      BRF = never,
                                                                                                                                                                                                                                                                                                                                      BJF = never,
                                                                                                                                                                                                                                                                                                                                      BNF = never,
                                                                                                                                                                                                                                                                                                                                      CRF = never,
                                                                                                                                                                                                                                                                                                                                      CJF = never,
                                                                                                                                                                                                                                                                                                                                      CNF = never,
                                                                                                                                                                                                                                                                                                                                      RRF = never,
                                                                                                                                                                                                                                                                                                                                      RJF = never,
                                                                                                                                                                                                                                                                                                                                      RNF = never,
                                                                                                                                                                                                                                                                                                                                      ARP = never,
                                                                                                                                                                                                                                                                                                                                      AJP = never,
                                                                                                                                                                                                                                                                                                                                      ANP = never,
                                                                                                                                                                                                                                                                                                                                      BRP = never,
                                                                                                                                                                                                                                                                                                                                      BJP = never,
                                                                                                                                                                                                                                                                                                                                      BNP = never,
                                                                                                                                                                                                                                                                                                                                      CRP = never,
                                                                                                                                                                                                                                                                                                                                      CJP = never,
                                                                                                                                                                                                                                                                                                                                      CNP = never,
                                                                                                                                                                                                                                                                                                                                      RRP = never,
                                                                                                                                                                                                                                                                                                                                      RJP = never,
                                                                                                                                                                                                                                                                                                                                      RNP = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      doneFilter: (
                                                                                                                                                                                                                                                                                                                                          t: T,
                                                                                                                                                                                                                                                                                                                                          u: T,
                                                                                                                                                                                                                                                                                                                                          v: T,
                                                                                                                                                                                                                                                                                                                                          ...s: T[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ARD
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                      failFilter: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ARF
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ARF>,
                                                                                                                                                                                                                                                                                                                                      progressFilter: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ANP
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                      ARD
                                                                                                                                                                                                                                                                                                                                      | ARF
                                                                                                                                                                                                                                                                                                                                      | ARP,
                                                                                                                                                                                                                                                                                                                                      AJD | AJF | AJP,
                                                                                                                                                                                                                                                                                                                                      AND | ANF | ANP,
                                                                                                                                                                                                                                                                                                                                      BRD | BRF | BRP,
                                                                                                                                                                                                                                                                                                                                      BJD | BJF | BJP,
                                                                                                                                                                                                                                                                                                                                      BND | BNF | BNP,
                                                                                                                                                                                                                                                                                                                                      CRD | CRF | CRP,
                                                                                                                                                                                                                                                                                                                                      CJD | CJF | CJP,
                                                                                                                                                                                                                                                                                                                                      CND | CNF | CNP,
                                                                                                                                                                                                                                                                                                                                      RRD | RRF | RRP,
                                                                                                                                                                                                                                                                                                                                      RJD | RJF | RJP,
                                                                                                                                                                                                                                                                                                                                      RND | RNF | RNP,
                                                                                                                                                                                                                                                                                                                                  >;
                                                                                                                                                                                                                                                                                                                                  then<
                                                                                                                                                                                                                                                                                                                                      ARF = never,
                                                                                                                                                                                                                                                                                                                                      AJF = never,
                                                                                                                                                                                                                                                                                                                                      ANF = never,
                                                                                                                                                                                                                                                                                                                                      BRF = never,
                                                                                                                                                                                                                                                                                                                                      BJF = never,
                                                                                                                                                                                                                                                                                                                                      BNF = never,
                                                                                                                                                                                                                                                                                                                                      CRF = never,
                                                                                                                                                                                                                                                                                                                                      CJF = never,
                                                                                                                                                                                                                                                                                                                                      CNF = never,
                                                                                                                                                                                                                                                                                                                                      RRF = never,
                                                                                                                                                                                                                                                                                                                                      RJF = never,
                                                                                                                                                                                                                                                                                                                                      RNF = never,
                                                                                                                                                                                                                                                                                                                                      ARP = never,
                                                                                                                                                                                                                                                                                                                                      AJP = never,
                                                                                                                                                                                                                                                                                                                                      ANP = never,
                                                                                                                                                                                                                                                                                                                                      BRP = never,
                                                                                                                                                                                                                                                                                                                                      BJP = never,
                                                                                                                                                                                                                                                                                                                                      BNP = never,
                                                                                                                                                                                                                                                                                                                                      CRP = never,
                                                                                                                                                                                                                                                                                                                                      CJP = never,
                                                                                                                                                                                                                                                                                                                                      CNP = never,
                                                                                                                                                                                                                                                                                                                                      RRP = never,
                                                                                                                                                                                                                                                                                                                                      RJP = never,
                                                                                                                                                                                                                                                                                                                                      RNP = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      doneFilter: null,
                                                                                                                                                                                                                                                                                                                                      failFilter: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ARF
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ARF>,
                                                                                                                                                                                                                                                                                                                                      progressFilter: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ANP
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                      ARF
                                                                                                                                                                                                                                                                                                                                      | ARP,
                                                                                                                                                                                                                                                                                                                                      AJF | AJP,
                                                                                                                                                                                                                                                                                                                                      ANF | ANP,
                                                                                                                                                                                                                                                                                                                                      BRF | BRP,
                                                                                                                                                                                                                                                                                                                                      BJF | BJP,
                                                                                                                                                                                                                                                                                                                                      BNF | BNP,
                                                                                                                                                                                                                                                                                                                                      CRF | CRP,
                                                                                                                                                                                                                                                                                                                                      CJF | CJP,
                                                                                                                                                                                                                                                                                                                                      CNF | CNP,
                                                                                                                                                                                                                                                                                                                                      RRF | RRP,
                                                                                                                                                                                                                                                                                                                                      RJF | RJP,
                                                                                                                                                                                                                                                                                                                                      RNF | RNP,
                                                                                                                                                                                                                                                                                                                                  >;
                                                                                                                                                                                                                                                                                                                                  then<
                                                                                                                                                                                                                                                                                                                                      ARD = never,
                                                                                                                                                                                                                                                                                                                                      AJD = never,
                                                                                                                                                                                                                                                                                                                                      AND = never,
                                                                                                                                                                                                                                                                                                                                      BRD = never,
                                                                                                                                                                                                                                                                                                                                      BJD = never,
                                                                                                                                                                                                                                                                                                                                      BND = never,
                                                                                                                                                                                                                                                                                                                                      CRD = never,
                                                                                                                                                                                                                                                                                                                                      CJD = never,
                                                                                                                                                                                                                                                                                                                                      CND = never,
                                                                                                                                                                                                                                                                                                                                      RRD = never,
                                                                                                                                                                                                                                                                                                                                      RJD = never,
                                                                                                                                                                                                                                                                                                                                      RND = never,
                                                                                                                                                                                                                                                                                                                                      ARP = never,
                                                                                                                                                                                                                                                                                                                                      AJP = never,
                                                                                                                                                                                                                                                                                                                                      ANP = never,
                                                                                                                                                                                                                                                                                                                                      BRP = never,
                                                                                                                                                                                                                                                                                                                                      BJP = never,
                                                                                                                                                                                                                                                                                                                                      BNP = never,
                                                                                                                                                                                                                                                                                                                                      CRP = never,
                                                                                                                                                                                                                                                                                                                                      CJP = never,
                                                                                                                                                                                                                                                                                                                                      CNP = never,
                                                                                                                                                                                                                                                                                                                                      RRP = never,
                                                                                                                                                                                                                                                                                                                                      RJP = never,
                                                                                                                                                                                                                                                                                                                                      RNP = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      doneFilter: (
                                                                                                                                                                                                                                                                                                                                          t: T,
                                                                                                                                                                                                                                                                                                                                          u: T,
                                                                                                                                                                                                                                                                                                                                          v: T,
                                                                                                                                                                                                                                                                                                                                          ...s: T[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ARD
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                      failFilter: null,
                                                                                                                                                                                                                                                                                                                                      progressFilter: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ANP
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                      ARD
                                                                                                                                                                                                                                                                                                                                      | ARP,
                                                                                                                                                                                                                                                                                                                                      AJD | AJP,
                                                                                                                                                                                                                                                                                                                                      AND | ANP,
                                                                                                                                                                                                                                                                                                                                      BRD | BRP,
                                                                                                                                                                                                                                                                                                                                      BJD | BJP,
                                                                                                                                                                                                                                                                                                                                      BND | BNP,
                                                                                                                                                                                                                                                                                                                                      CRD | CRP,
                                                                                                                                                                                                                                                                                                                                      CJD | CJP,
                                                                                                                                                                                                                                                                                                                                      CND | CNP,
                                                                                                                                                                                                                                                                                                                                      RRD | RRP,
                                                                                                                                                                                                                                                                                                                                      RJD | RJP,
                                                                                                                                                                                                                                                                                                                                      RND | RNP,
                                                                                                                                                                                                                                                                                                                                  >;
                                                                                                                                                                                                                                                                                                                                  then<
                                                                                                                                                                                                                                                                                                                                      ARP = never,
                                                                                                                                                                                                                                                                                                                                      AJP = never,
                                                                                                                                                                                                                                                                                                                                      ANP = never,
                                                                                                                                                                                                                                                                                                                                      BRP = never,
                                                                                                                                                                                                                                                                                                                                      BJP = never,
                                                                                                                                                                                                                                                                                                                                      BNP = never,
                                                                                                                                                                                                                                                                                                                                      CRP = never,
                                                                                                                                                                                                                                                                                                                                      CJP = never,
                                                                                                                                                                                                                                                                                                                                      CNP = never,
                                                                                                                                                                                                                                                                                                                                      RRP = never,
                                                                                                                                                                                                                                                                                                                                      RJP = never,
                                                                                                                                                                                                                                                                                                                                      RNP = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      doneFilter: null,
                                                                                                                                                                                                                                                                                                                                      failFilter: null,
                                                                                                                                                                                                                                                                                                                                      progressFilter?: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ANP
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>;
                                                                                                                                                                                                                                                                                                                                  then<
                                                                                                                                                                                                                                                                                                                                      ARD = never,
                                                                                                                                                                                                                                                                                                                                      AJD = never,
                                                                                                                                                                                                                                                                                                                                      AND = never,
                                                                                                                                                                                                                                                                                                                                      BRD = never,
                                                                                                                                                                                                                                                                                                                                      BJD = never,
                                                                                                                                                                                                                                                                                                                                      BND = never,
                                                                                                                                                                                                                                                                                                                                      CRD = never,
                                                                                                                                                                                                                                                                                                                                      CJD = never,
                                                                                                                                                                                                                                                                                                                                      CND = never,
                                                                                                                                                                                                                                                                                                                                      RRD = never,
                                                                                                                                                                                                                                                                                                                                      RJD = never,
                                                                                                                                                                                                                                                                                                                                      RND = never,
                                                                                                                                                                                                                                                                                                                                      ARF = never,
                                                                                                                                                                                                                                                                                                                                      AJF = never,
                                                                                                                                                                                                                                                                                                                                      ANF = never,
                                                                                                                                                                                                                                                                                                                                      BRF = never,
                                                                                                                                                                                                                                                                                                                                      BJF = never,
                                                                                                                                                                                                                                                                                                                                      BNF = never,
                                                                                                                                                                                                                                                                                                                                      CRF = never,
                                                                                                                                                                                                                                                                                                                                      CJF = never,
                                                                                                                                                                                                                                                                                                                                      CNF = never,
                                                                                                                                                                                                                                                                                                                                      RRF = never,
                                                                                                                                                                                                                                                                                                                                      RJF = never,
                                                                                                                                                                                                                                                                                                                                      RNF = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      doneFilter: (
                                                                                                                                                                                                                                                                                                                                          t: T,
                                                                                                                                                                                                                                                                                                                                          u: T,
                                                                                                                                                                                                                                                                                                                                          v: T,
                                                                                                                                                                                                                                                                                                                                          ...s: T[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ARD
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                      failFilter: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ARF
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ARF>,
                                                                                                                                                                                                                                                                                                                                      progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                      ARD
                                                                                                                                                                                                                                                                                                                                      | ARF,
                                                                                                                                                                                                                                                                                                                                      AJD | AJF,
                                                                                                                                                                                                                                                                                                                                      AND | ANF,
                                                                                                                                                                                                                                                                                                                                      BRD | BRF,
                                                                                                                                                                                                                                                                                                                                      BJD | BJF,
                                                                                                                                                                                                                                                                                                                                      BND | BNF,
                                                                                                                                                                                                                                                                                                                                      CRD | CRF,
                                                                                                                                                                                                                                                                                                                                      CJD | CJF,
                                                                                                                                                                                                                                                                                                                                      CND | CNF,
                                                                                                                                                                                                                                                                                                                                      RRD | RRF,
                                                                                                                                                                                                                                                                                                                                      RJD | RJF,
                                                                                                                                                                                                                                                                                                                                      RND | RNF,
                                                                                                                                                                                                                                                                                                                                  >;
                                                                                                                                                                                                                                                                                                                                  then<
                                                                                                                                                                                                                                                                                                                                      ARF = never,
                                                                                                                                                                                                                                                                                                                                      AJF = never,
                                                                                                                                                                                                                                                                                                                                      ANF = never,
                                                                                                                                                                                                                                                                                                                                      BRF = never,
                                                                                                                                                                                                                                                                                                                                      BJF = never,
                                                                                                                                                                                                                                                                                                                                      BNF = never,
                                                                                                                                                                                                                                                                                                                                      CRF = never,
                                                                                                                                                                                                                                                                                                                                      CJF = never,
                                                                                                                                                                                                                                                                                                                                      CNF = never,
                                                                                                                                                                                                                                                                                                                                      RRF = never,
                                                                                                                                                                                                                                                                                                                                      RJF = never,
                                                                                                                                                                                                                                                                                                                                      RNF = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      doneFilter: null,
                                                                                                                                                                                                                                                                                                                                      failFilter: (
                                                                                                                                                                                                                                                                                                                                          t: any,
                                                                                                                                                                                                                                                                                                                                          u: any,
                                                                                                                                                                                                                                                                                                                                          v: any,
                                                                                                                                                                                                                                                                                                                                          ...s: any[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ARF
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ARF>,
                                                                                                                                                                                                                                                                                                                                      progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>;
                                                                                                                                                                                                                                                                                                                                  then<
                                                                                                                                                                                                                                                                                                                                      ARD = never,
                                                                                                                                                                                                                                                                                                                                      AJD = never,
                                                                                                                                                                                                                                                                                                                                      AND = never,
                                                                                                                                                                                                                                                                                                                                      BRD = never,
                                                                                                                                                                                                                                                                                                                                      BJD = never,
                                                                                                                                                                                                                                                                                                                                      BND = never,
                                                                                                                                                                                                                                                                                                                                      CRD = never,
                                                                                                                                                                                                                                                                                                                                      CJD = never,
                                                                                                                                                                                                                                                                                                                                      CND = never,
                                                                                                                                                                                                                                                                                                                                      RRD = never,
                                                                                                                                                                                                                                                                                                                                      RJD = never,
                                                                                                                                                                                                                                                                                                                                      RND = never,
                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                      doneFilter: (
                                                                                                                                                                                                                                                                                                                                          t: T,
                                                                                                                                                                                                                                                                                                                                          u: T,
                                                                                                                                                                                                                                                                                                                                          v: T,
                                                                                                                                                                                                                                                                                                                                          ...s: T[],
                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                          | ARD
                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                          | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                      failFilter?: null,
                                                                                                                                                                                                                                                                                                                                      progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                  ): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>;
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                              always +catch +done +fail +pipe +progress +promise +state +then +

                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                              • Add handlers to be called when the Deferred object is either resolved or rejected.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • alwaysCallback: TypeOrArray<CallbackBase<any, any, any, any>>

                                                                                                                                                                                                                                                                                                                                  A function, or array of functions, that is called when the Deferred is resolved or rejected.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • ...alwaysCallbacks: TypeOrArray<CallbackBase<any, any, any, any>>[]

                                                                                                                                                                                                                                                                                                                                  Optional additional functions, or arrays of functions, that are called when the Deferred is resolved or rejected.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.always/">https://api.jquery.com/deferred.always/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.6

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Since the jQuery.get() method returns a jqXHR object, which is derived from a Deferred object, we can attach a callback for both success and error using the deferred.always() method.

                                                                                                                                                                                                                                                                                                                                $.get( "test.php" ).always(function() {
                                                                                                                                                                                                                                                                                                                                alert( "$.get completed with success or error callback arguments" );
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Add handlers to be called when the Deferred object is rejected.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARF = never
                                                                                                                                                                                                                                                                                                                                • AJF = never
                                                                                                                                                                                                                                                                                                                                • ANF = never
                                                                                                                                                                                                                                                                                                                                • BRF = never
                                                                                                                                                                                                                                                                                                                                • BJF = never
                                                                                                                                                                                                                                                                                                                                • BNF = never
                                                                                                                                                                                                                                                                                                                                • CRF = never
                                                                                                                                                                                                                                                                                                                                • CJF = never
                                                                                                                                                                                                                                                                                                                                • CNF = never
                                                                                                                                                                                                                                                                                                                                • RRF = never
                                                                                                                                                                                                                                                                                                                                • RJF = never
                                                                                                                                                                                                                                                                                                                                • RNF = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • OptionalfailFilter:
                                                                                                                                                                                                                                                                                                                                      | null
                                                                                                                                                                                                                                                                                                                                      | (
                                                                                                                                                                                                                                                                                                                                          (
                                                                                                                                                                                                                                                                                                                                              t: any,
                                                                                                                                                                                                                                                                                                                                              u: any,
                                                                                                                                                                                                                                                                                                                                              v: any,
                                                                                                                                                                                                                                                                                                                                              ...s: any[],
                                                                                                                                                                                                                                                                                                                                          ) =>
                                                                                                                                                                                                                                                                                                                                              | ARF
                                                                                                                                                                                                                                                                                                                                              | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                              | Thenable<ARF>
                                                                                                                                                                                                                                                                                                                                      )

                                                                                                                                                                                                                                                                                                                                  A function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.catch/">https://api.jquery.com/deferred.catch/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                3.0

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can rejection handlers using the .catch method.

                                                                                                                                                                                                                                                                                                                                $.get( "test.php" )
                                                                                                                                                                                                                                                                                                                                .then( function() {
                                                                                                                                                                                                                                                                                                                                alert( "$.get succeeded" );
                                                                                                                                                                                                                                                                                                                                } )
                                                                                                                                                                                                                                                                                                                                .catch( function() {
                                                                                                                                                                                                                                                                                                                                alert( "$.get failed!" );
                                                                                                                                                                                                                                                                                                                                } );
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Add handlers to be called when the Deferred object is resolved.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • doneCallback: TypeOrArray<CallbackBase<T, T, T, T>>

                                                                                                                                                                                                                                                                                                                                  A function, or array of functions, that are called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • ...doneCallbacks: TypeOrArray<CallbackBase<T, T, T, T>>[]

                                                                                                                                                                                                                                                                                                                                  Optional additional functions, or arrays of functions, that are called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.done/">https://api.jquery.com/deferred.done/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.5

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach a success callback using the .done() method. +```javascript +$.get( "test.php" ).done(function() { +alert( "$.get succeeded" ); +}); +``` +@example ​ ````Resolve a Deferred object when the user clicks a button, triggering a number of callback functions:

                                                                                                                                                                                                                                                                                                                                <!doctype html>
                                                                                                                                                                                                                                                                                                                                <html lang="en">
                                                                                                                                                                                                                                                                                                                                <head>
                                                                                                                                                                                                                                                                                                                                <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                <title>deferred.done demo</title>
                                                                                                                                                                                                                                                                                                                                <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                </head>
                                                                                                                                                                                                                                                                                                                                <body>
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                <button>Go</button>
                                                                                                                                                                                                                                                                                                                                <p>Ready...</p>
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                <script>
                                                                                                                                                                                                                                                                                                                                // 3 functions to call when the Deferred object is resolved
                                                                                                                                                                                                                                                                                                                                function fn1() {
                                                                                                                                                                                                                                                                                                                                $( "p" ).append( " 1 " );
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                function fn2() {
                                                                                                                                                                                                                                                                                                                                $( "p" ).append( " 2 " );
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                function fn3( n ) {
                                                                                                                                                                                                                                                                                                                                $( "p" ).append( n + " 3 " + n );
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                // Create a deferred object
                                                                                                                                                                                                                                                                                                                                var dfd = $.Deferred();
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                // Add handlers to be called when dfd is resolved
                                                                                                                                                                                                                                                                                                                                dfd
                                                                                                                                                                                                                                                                                                                                // .done() can take any number of functions or arrays of functions
                                                                                                                                                                                                                                                                                                                                .done( [ fn1, fn2 ], fn3, [ fn2, fn1 ] )
                                                                                                                                                                                                                                                                                                                                // We can chain done methods, too
                                                                                                                                                                                                                                                                                                                                .done(function( n ) {
                                                                                                                                                                                                                                                                                                                                $( "p" ).append( n + " we're done." );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                // Resolve the Deferred object when the button is clicked
                                                                                                                                                                                                                                                                                                                                $( "button" ).on( "click", function() {
                                                                                                                                                                                                                                                                                                                                dfd.resolve( "and" );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                </script>
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                </body>
                                                                                                                                                                                                                                                                                                                                </html>
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Add handlers to be called when the Deferred object is rejected.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • failCallback: TypeOrArray<CallbackBase<any, any, any, any>>

                                                                                                                                                                                                                                                                                                                                  A function, or array of functions, that are called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • ...failCallbacks: TypeOrArray<CallbackBase<any, any, any, any>>[]

                                                                                                                                                                                                                                                                                                                                  Optional additional functions, or arrays of functions, that are called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.fail/">https://api.jquery.com/deferred.fail/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.5

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred, you can attach a success and failure callback using the deferred.done() and deferred.fail() methods.

                                                                                                                                                                                                                                                                                                                                $.get( "test.php" )
                                                                                                                                                                                                                                                                                                                                .done(function() {
                                                                                                                                                                                                                                                                                                                                alert( "$.get succeeded" );
                                                                                                                                                                                                                                                                                                                                })
                                                                                                                                                                                                                                                                                                                                .fail(function() {
                                                                                                                                                                                                                                                                                                                                alert( "$.get failed!" );
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARD = never
                                                                                                                                                                                                                                                                                                                                • AJD = never
                                                                                                                                                                                                                                                                                                                                • AND = never
                                                                                                                                                                                                                                                                                                                                • BRD = never
                                                                                                                                                                                                                                                                                                                                • BJD = never
                                                                                                                                                                                                                                                                                                                                • BND = never
                                                                                                                                                                                                                                                                                                                                • CRD = never
                                                                                                                                                                                                                                                                                                                                • CJD = never
                                                                                                                                                                                                                                                                                                                                • CND = never
                                                                                                                                                                                                                                                                                                                                • RRD = never
                                                                                                                                                                                                                                                                                                                                • RJD = never
                                                                                                                                                                                                                                                                                                                                • RND = never
                                                                                                                                                                                                                                                                                                                                • ARF = never
                                                                                                                                                                                                                                                                                                                                • AJF = never
                                                                                                                                                                                                                                                                                                                                • ANF = never
                                                                                                                                                                                                                                                                                                                                • BRF = never
                                                                                                                                                                                                                                                                                                                                • BJF = never
                                                                                                                                                                                                                                                                                                                                • BNF = never
                                                                                                                                                                                                                                                                                                                                • CRF = never
                                                                                                                                                                                                                                                                                                                                • CJF = never
                                                                                                                                                                                                                                                                                                                                • CNF = never
                                                                                                                                                                                                                                                                                                                                • RRF = never
                                                                                                                                                                                                                                                                                                                                • RJF = never
                                                                                                                                                                                                                                                                                                                                • RNF = never
                                                                                                                                                                                                                                                                                                                                • ARP = never
                                                                                                                                                                                                                                                                                                                                • AJP = never
                                                                                                                                                                                                                                                                                                                                • ANP = never
                                                                                                                                                                                                                                                                                                                                • BRP = never
                                                                                                                                                                                                                                                                                                                                • BJP = never
                                                                                                                                                                                                                                                                                                                                • BNP = never
                                                                                                                                                                                                                                                                                                                                • CRP = never
                                                                                                                                                                                                                                                                                                                                • CJP = never
                                                                                                                                                                                                                                                                                                                                • CNP = never
                                                                                                                                                                                                                                                                                                                                • RRP = never
                                                                                                                                                                                                                                                                                                                                • RJP = never
                                                                                                                                                                                                                                                                                                                                • RNP = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                    ARD
                                                                                                                                                                                                                                                                                                                                    | ARF
                                                                                                                                                                                                                                                                                                                                    | ARP,
                                                                                                                                                                                                                                                                                                                                    AJD | AJF | AJP,
                                                                                                                                                                                                                                                                                                                                    AND | ANF | ANP,
                                                                                                                                                                                                                                                                                                                                    BRD | BRF | BRP,
                                                                                                                                                                                                                                                                                                                                    BJD | BJF | BJP,
                                                                                                                                                                                                                                                                                                                                    BND | BNF | BNP,
                                                                                                                                                                                                                                                                                                                                    CRD | CRF | CRP,
                                                                                                                                                                                                                                                                                                                                    CJD | CJF | CJP,
                                                                                                                                                                                                                                                                                                                                    CND | CNF | CNP,
                                                                                                                                                                                                                                                                                                                                    RRD | RRF | RRP,
                                                                                                                                                                                                                                                                                                                                    RJD | RJF | RJP,
                                                                                                                                                                                                                                                                                                                                    RND | RNF | RNP,
                                                                                                                                                                                                                                                                                                                                >

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.6

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.7

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Filter resolve value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +alert( "Value is ( 2*5 = ) 10: " + value ); +}); +``` +@example ​ ````Filter reject value:

                                                                                                                                                                                                                                                                                                                                var defer = $.Deferred(),
                                                                                                                                                                                                                                                                                                                                filtered = defer.pipe( null, function( value ) {
                                                                                                                                                                                                                                                                                                                                return value * 3;
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                defer.reject( 6 );
                                                                                                                                                                                                                                                                                                                                filtered.fail(function( value ) {
                                                                                                                                                                                                                                                                                                                                alert( "Value is ( 3*6 = ) 18: " + value );
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARF = never
                                                                                                                                                                                                                                                                                                                                • AJF = never
                                                                                                                                                                                                                                                                                                                                • ANF = never
                                                                                                                                                                                                                                                                                                                                • BRF = never
                                                                                                                                                                                                                                                                                                                                • BJF = never
                                                                                                                                                                                                                                                                                                                                • BNF = never
                                                                                                                                                                                                                                                                                                                                • CRF = never
                                                                                                                                                                                                                                                                                                                                • CJF = never
                                                                                                                                                                                                                                                                                                                                • CNF = never
                                                                                                                                                                                                                                                                                                                                • RRF = never
                                                                                                                                                                                                                                                                                                                                • RJF = never
                                                                                                                                                                                                                                                                                                                                • RNF = never
                                                                                                                                                                                                                                                                                                                                • ARP = never
                                                                                                                                                                                                                                                                                                                                • AJP = never
                                                                                                                                                                                                                                                                                                                                • ANP = never
                                                                                                                                                                                                                                                                                                                                • BRP = never
                                                                                                                                                                                                                                                                                                                                • BJP = never
                                                                                                                                                                                                                                                                                                                                • BNP = never
                                                                                                                                                                                                                                                                                                                                • CRP = never
                                                                                                                                                                                                                                                                                                                                • CJP = never
                                                                                                                                                                                                                                                                                                                                • CNP = never
                                                                                                                                                                                                                                                                                                                                • RRP = never
                                                                                                                                                                                                                                                                                                                                • RJP = never
                                                                                                                                                                                                                                                                                                                                • RNP = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • doneFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • failFilter: (
                                                                                                                                                                                                                                                                                                                                      t: any,
                                                                                                                                                                                                                                                                                                                                      u: any,
                                                                                                                                                                                                                                                                                                                                      v: any,
                                                                                                                                                                                                                                                                                                                                      ...s: any[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | AJF
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                      | Thenable<AJF>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • progressFilter: (
                                                                                                                                                                                                                                                                                                                                      t: any,
                                                                                                                                                                                                                                                                                                                                      u: any,
                                                                                                                                                                                                                                                                                                                                      v: any,
                                                                                                                                                                                                                                                                                                                                      ...s: any[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ANP
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ANP>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                    ARF
                                                                                                                                                                                                                                                                                                                                    | ARP,
                                                                                                                                                                                                                                                                                                                                    AJF | AJP,
                                                                                                                                                                                                                                                                                                                                    ANF | ANP,
                                                                                                                                                                                                                                                                                                                                    BRF | BRP,
                                                                                                                                                                                                                                                                                                                                    BJF | BJP,
                                                                                                                                                                                                                                                                                                                                    BNF | BNP,
                                                                                                                                                                                                                                                                                                                                    CRF | CRP,
                                                                                                                                                                                                                                                                                                                                    CJF | CJP,
                                                                                                                                                                                                                                                                                                                                    CNF | CNP,
                                                                                                                                                                                                                                                                                                                                    RRF | RRP,
                                                                                                                                                                                                                                                                                                                                    RJF | RJP,
                                                                                                                                                                                                                                                                                                                                    RNF | RNP,
                                                                                                                                                                                                                                                                                                                                >

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.6

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.7

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARD = never
                                                                                                                                                                                                                                                                                                                                • AJD = never
                                                                                                                                                                                                                                                                                                                                • AND = never
                                                                                                                                                                                                                                                                                                                                • BRD = never
                                                                                                                                                                                                                                                                                                                                • BJD = never
                                                                                                                                                                                                                                                                                                                                • BND = never
                                                                                                                                                                                                                                                                                                                                • CRD = never
                                                                                                                                                                                                                                                                                                                                • CJD = never
                                                                                                                                                                                                                                                                                                                                • CND = never
                                                                                                                                                                                                                                                                                                                                • RRD = never
                                                                                                                                                                                                                                                                                                                                • RJD = never
                                                                                                                                                                                                                                                                                                                                • RND = never
                                                                                                                                                                                                                                                                                                                                • ARP = never
                                                                                                                                                                                                                                                                                                                                • AJP = never
                                                                                                                                                                                                                                                                                                                                • ANP = never
                                                                                                                                                                                                                                                                                                                                • BRP = never
                                                                                                                                                                                                                                                                                                                                • BJP = never
                                                                                                                                                                                                                                                                                                                                • BNP = never
                                                                                                                                                                                                                                                                                                                                • CRP = never
                                                                                                                                                                                                                                                                                                                                • CJP = never
                                                                                                                                                                                                                                                                                                                                • CNP = never
                                                                                                                                                                                                                                                                                                                                • RRP = never
                                                                                                                                                                                                                                                                                                                                • RJP = never
                                                                                                                                                                                                                                                                                                                                • RNP = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • doneFilter: (
                                                                                                                                                                                                                                                                                                                                      t: T,
                                                                                                                                                                                                                                                                                                                                      u: T,
                                                                                                                                                                                                                                                                                                                                      v: T,
                                                                                                                                                                                                                                                                                                                                      ...s: T[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ARD
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ARD>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • failFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • progressFilter: (
                                                                                                                                                                                                                                                                                                                                      t: any,
                                                                                                                                                                                                                                                                                                                                      u: any,
                                                                                                                                                                                                                                                                                                                                      v: any,
                                                                                                                                                                                                                                                                                                                                      ...s: any[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ANP
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ANP>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                    ARD
                                                                                                                                                                                                                                                                                                                                    | ARP,
                                                                                                                                                                                                                                                                                                                                    AJD | AJP,
                                                                                                                                                                                                                                                                                                                                    AND | ANP,
                                                                                                                                                                                                                                                                                                                                    BRD | BRP,
                                                                                                                                                                                                                                                                                                                                    BJD | BJP,
                                                                                                                                                                                                                                                                                                                                    BND | BNP,
                                                                                                                                                                                                                                                                                                                                    CRD | CRP,
                                                                                                                                                                                                                                                                                                                                    CJD | CJP,
                                                                                                                                                                                                                                                                                                                                    CND | CNP,
                                                                                                                                                                                                                                                                                                                                    RRD | RRP,
                                                                                                                                                                                                                                                                                                                                    RJD | RJP,
                                                                                                                                                                                                                                                                                                                                    RND | RNP,
                                                                                                                                                                                                                                                                                                                                >

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.6

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.7

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Filter resolve value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +alert( "Value is ( 2*5 = ) 10: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARP = never
                                                                                                                                                                                                                                                                                                                                • AJP = never
                                                                                                                                                                                                                                                                                                                                • ANP = never
                                                                                                                                                                                                                                                                                                                                • BRP = never
                                                                                                                                                                                                                                                                                                                                • BJP = never
                                                                                                                                                                                                                                                                                                                                • BNP = never
                                                                                                                                                                                                                                                                                                                                • CRP = never
                                                                                                                                                                                                                                                                                                                                • CJP = never
                                                                                                                                                                                                                                                                                                                                • CNP = never
                                                                                                                                                                                                                                                                                                                                • RRP = never
                                                                                                                                                                                                                                                                                                                                • RJP = never
                                                                                                                                                                                                                                                                                                                                • RNP = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • doneFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • failFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalprogressFilter: (
                                                                                                                                                                                                                                                                                                                                      t: any,
                                                                                                                                                                                                                                                                                                                                      u: any,
                                                                                                                                                                                                                                                                                                                                      v: any,
                                                                                                                                                                                                                                                                                                                                      ...s: any[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ANP
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ANP>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.6

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.7

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARD = never
                                                                                                                                                                                                                                                                                                                                • AJD = never
                                                                                                                                                                                                                                                                                                                                • AND = never
                                                                                                                                                                                                                                                                                                                                • BRD = never
                                                                                                                                                                                                                                                                                                                                • BJD = never
                                                                                                                                                                                                                                                                                                                                • BND = never
                                                                                                                                                                                                                                                                                                                                • CRD = never
                                                                                                                                                                                                                                                                                                                                • CJD = never
                                                                                                                                                                                                                                                                                                                                • CND = never
                                                                                                                                                                                                                                                                                                                                • RRD = never
                                                                                                                                                                                                                                                                                                                                • RJD = never
                                                                                                                                                                                                                                                                                                                                • RND = never
                                                                                                                                                                                                                                                                                                                                • ARF = never
                                                                                                                                                                                                                                                                                                                                • AJF = never
                                                                                                                                                                                                                                                                                                                                • ANF = never
                                                                                                                                                                                                                                                                                                                                • BRF = never
                                                                                                                                                                                                                                                                                                                                • BJF = never
                                                                                                                                                                                                                                                                                                                                • BNF = never
                                                                                                                                                                                                                                                                                                                                • CRF = never
                                                                                                                                                                                                                                                                                                                                • CJF = never
                                                                                                                                                                                                                                                                                                                                • CNF = never
                                                                                                                                                                                                                                                                                                                                • RRF = never
                                                                                                                                                                                                                                                                                                                                • RJF = never
                                                                                                                                                                                                                                                                                                                                • RNF = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • doneFilter: (
                                                                                                                                                                                                                                                                                                                                      t: T,
                                                                                                                                                                                                                                                                                                                                      u: T,
                                                                                                                                                                                                                                                                                                                                      v: T,
                                                                                                                                                                                                                                                                                                                                      ...s: T[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ARD
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ARD>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • failFilter: (
                                                                                                                                                                                                                                                                                                                                      t: any,
                                                                                                                                                                                                                                                                                                                                      u: any,
                                                                                                                                                                                                                                                                                                                                      v: any,
                                                                                                                                                                                                                                                                                                                                      ...s: any[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | AJF
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                      | Thenable<AJF>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalprogressFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                    ARD
                                                                                                                                                                                                                                                                                                                                    | ARF,
                                                                                                                                                                                                                                                                                                                                    AJD | AJF,
                                                                                                                                                                                                                                                                                                                                    AND | ANF,
                                                                                                                                                                                                                                                                                                                                    BRD | BRF,
                                                                                                                                                                                                                                                                                                                                    BJD | BJF,
                                                                                                                                                                                                                                                                                                                                    BND | BNF,
                                                                                                                                                                                                                                                                                                                                    CRD | CRF,
                                                                                                                                                                                                                                                                                                                                    CJD | CJF,
                                                                                                                                                                                                                                                                                                                                    CND | CNF,
                                                                                                                                                                                                                                                                                                                                    RRD | RRF,
                                                                                                                                                                                                                                                                                                                                    RJD | RJF,
                                                                                                                                                                                                                                                                                                                                    RND | RNF,
                                                                                                                                                                                                                                                                                                                                >

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.6

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.7

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Filter resolve value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +alert( "Value is ( 2*5 = ) 10: " + value ); +}); +``` +@example ​ ````Filter reject value:

                                                                                                                                                                                                                                                                                                                                var defer = $.Deferred(),
                                                                                                                                                                                                                                                                                                                                filtered = defer.pipe( null, function( value ) {
                                                                                                                                                                                                                                                                                                                                return value * 3;
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                defer.reject( 6 );
                                                                                                                                                                                                                                                                                                                                filtered.fail(function( value ) {
                                                                                                                                                                                                                                                                                                                                alert( "Value is ( 3*6 = ) 18: " + value );
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARF = never
                                                                                                                                                                                                                                                                                                                                • AJF = never
                                                                                                                                                                                                                                                                                                                                • ANF = never
                                                                                                                                                                                                                                                                                                                                • BRF = never
                                                                                                                                                                                                                                                                                                                                • BJF = never
                                                                                                                                                                                                                                                                                                                                • BNF = never
                                                                                                                                                                                                                                                                                                                                • CRF = never
                                                                                                                                                                                                                                                                                                                                • CJF = never
                                                                                                                                                                                                                                                                                                                                • CNF = never
                                                                                                                                                                                                                                                                                                                                • RRF = never
                                                                                                                                                                                                                                                                                                                                • RJF = never
                                                                                                                                                                                                                                                                                                                                • RNF = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • doneFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • failFilter: (
                                                                                                                                                                                                                                                                                                                                      t: any,
                                                                                                                                                                                                                                                                                                                                      u: any,
                                                                                                                                                                                                                                                                                                                                      v: any,
                                                                                                                                                                                                                                                                                                                                      ...s: any[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | AJF
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                      | Thenable<AJF>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalprogressFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.6

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.7

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARD = never
                                                                                                                                                                                                                                                                                                                                • AJD = never
                                                                                                                                                                                                                                                                                                                                • AND = never
                                                                                                                                                                                                                                                                                                                                • BRD = never
                                                                                                                                                                                                                                                                                                                                • BJD = never
                                                                                                                                                                                                                                                                                                                                • BND = never
                                                                                                                                                                                                                                                                                                                                • CRD = never
                                                                                                                                                                                                                                                                                                                                • CJD = never
                                                                                                                                                                                                                                                                                                                                • CND = never
                                                                                                                                                                                                                                                                                                                                • RRD = never
                                                                                                                                                                                                                                                                                                                                • RJD = never
                                                                                                                                                                                                                                                                                                                                • RND = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • doneFilter: (
                                                                                                                                                                                                                                                                                                                                      t: T,
                                                                                                                                                                                                                                                                                                                                      u: T,
                                                                                                                                                                                                                                                                                                                                      v: T,
                                                                                                                                                                                                                                                                                                                                      ...s: T[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ARD
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ARD>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalfailFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalprogressFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.6

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.7

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Filter resolve value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +alert( "Value is ( 2*5 = ) 10: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Add handlers to be called when the Deferred object generates progress notifications.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • progressCallback: TypeOrArray<CallbackBase<any, any, any, any>>

                                                                                                                                                                                                                                                                                                                                  A function, or array of functions, to be called when the Deferred generates progress notifications.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • ...progressCallbacks: TypeOrArray<CallbackBase<any, any, any, any>>[]

                                                                                                                                                                                                                                                                                                                                  Optional additional functions, or arrays of functions, to be called when the Deferred generates +progress notifications.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.progress/">https://api.jquery.com/deferred.progress/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.7

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                              • Return a Deferred's Promise object.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • TTarget extends object

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • target: TTarget

                                                                                                                                                                                                                                                                                                                                  Object onto which the promise methods have to be attached

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns JQueryPromise<T> & TTarget

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.promise/">https://api.jquery.com/deferred.promise/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.5

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Create a Deferred and set two timer-based functions to either resolve or reject the Deferred after a random interval. Whichever one fires first &quot;wins&quot; and will call one of the callbacks. The second timeout has no effect since the Deferred is already complete (in a resolved or rejected state) from the first timeout action. Also set a timer-based progress notification function, and call a progress handler that adds &quot;working...&quot; to the document body.

                                                                                                                                                                                                                                                                                                                                function asyncEvent() {
                                                                                                                                                                                                                                                                                                                                var dfd = jQuery.Deferred();
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                // Resolve after a random interval
                                                                                                                                                                                                                                                                                                                                setTimeout(function() {
                                                                                                                                                                                                                                                                                                                                dfd.resolve( "hurray" );
                                                                                                                                                                                                                                                                                                                                }, Math.floor( 400 + Math.random() * 2000 ) );
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                // Reject after a random interval
                                                                                                                                                                                                                                                                                                                                setTimeout(function() {
                                                                                                                                                                                                                                                                                                                                dfd.reject( "sorry" );
                                                                                                                                                                                                                                                                                                                                }, Math.floor( 400 + Math.random() * 2000 ) );
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                // Show a "working..." message every half-second
                                                                                                                                                                                                                                                                                                                                setTimeout(function working() {
                                                                                                                                                                                                                                                                                                                                if ( dfd.state() === "pending" ) {
                                                                                                                                                                                                                                                                                                                                dfd.notify( "working... " );
                                                                                                                                                                                                                                                                                                                                setTimeout( working, 500 );
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                }, 1 );
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                // Return the Promise so caller can't change the Deferred
                                                                                                                                                                                                                                                                                                                                return dfd.promise();
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                // Attach a done, fail, and progress handler for the asyncEvent
                                                                                                                                                                                                                                                                                                                                $.when( asyncEvent() ).then(
                                                                                                                                                                                                                                                                                                                                function( status ) {
                                                                                                                                                                                                                                                                                                                                alert( status + ", things are going well" );
                                                                                                                                                                                                                                                                                                                                },
                                                                                                                                                                                                                                                                                                                                function( status ) {
                                                                                                                                                                                                                                                                                                                                alert( status + ", you fail this time" );
                                                                                                                                                                                                                                                                                                                                },
                                                                                                                                                                                                                                                                                                                                function( status ) {
                                                                                                                                                                                                                                                                                                                                $( "body" ).append( status );
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                );
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Return a Deferred's Promise object.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.promise/">https://api.jquery.com/deferred.promise/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.5

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Use the target argument to promote an existing object to a Promise:

                                                                                                                                                                                                                                                                                                                                // Existing object
                                                                                                                                                                                                                                                                                                                                var obj = {
                                                                                                                                                                                                                                                                                                                                hello: function( name ) {
                                                                                                                                                                                                                                                                                                                                alert( "Hello " + name );
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                },
                                                                                                                                                                                                                                                                                                                                // Create a Deferred
                                                                                                                                                                                                                                                                                                                                defer = $.Deferred();
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                // Set object as a promise
                                                                                                                                                                                                                                                                                                                                defer.promise( obj );
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                // Resolve the deferred
                                                                                                                                                                                                                                                                                                                                defer.resolve( "John" );
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                // Use the object as a Promise
                                                                                                                                                                                                                                                                                                                                obj.done(function( name ) {
                                                                                                                                                                                                                                                                                                                                obj.hello( name ); // Will alert "Hello John"
                                                                                                                                                                                                                                                                                                                                }).hello( "Karl" ); // Will alert "Hello Karl"
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Determine the current state of a Deferred object.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Returns "pending" | "resolved" | "rejected"

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.state/">https://api.jquery.com/deferred.state/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.7

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                              • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARD = never
                                                                                                                                                                                                                                                                                                                                • AJD = never
                                                                                                                                                                                                                                                                                                                                • AND = never
                                                                                                                                                                                                                                                                                                                                • BRD = never
                                                                                                                                                                                                                                                                                                                                • BJD = never
                                                                                                                                                                                                                                                                                                                                • BND = never
                                                                                                                                                                                                                                                                                                                                • CRD = never
                                                                                                                                                                                                                                                                                                                                • CJD = never
                                                                                                                                                                                                                                                                                                                                • CND = never
                                                                                                                                                                                                                                                                                                                                • RRD = never
                                                                                                                                                                                                                                                                                                                                • RJD = never
                                                                                                                                                                                                                                                                                                                                • RND = never
                                                                                                                                                                                                                                                                                                                                • ARF = never
                                                                                                                                                                                                                                                                                                                                • AJF = never
                                                                                                                                                                                                                                                                                                                                • ANF = never
                                                                                                                                                                                                                                                                                                                                • BRF = never
                                                                                                                                                                                                                                                                                                                                • BJF = never
                                                                                                                                                                                                                                                                                                                                • BNF = never
                                                                                                                                                                                                                                                                                                                                • CRF = never
                                                                                                                                                                                                                                                                                                                                • CJF = never
                                                                                                                                                                                                                                                                                                                                • CNF = never
                                                                                                                                                                                                                                                                                                                                • RRF = never
                                                                                                                                                                                                                                                                                                                                • RJF = never
                                                                                                                                                                                                                                                                                                                                • RNF = never
                                                                                                                                                                                                                                                                                                                                • ARP = never
                                                                                                                                                                                                                                                                                                                                • AJP = never
                                                                                                                                                                                                                                                                                                                                • ANP = never
                                                                                                                                                                                                                                                                                                                                • BRP = never
                                                                                                                                                                                                                                                                                                                                • BJP = never
                                                                                                                                                                                                                                                                                                                                • BNP = never
                                                                                                                                                                                                                                                                                                                                • CRP = never
                                                                                                                                                                                                                                                                                                                                • CJP = never
                                                                                                                                                                                                                                                                                                                                • CNP = never
                                                                                                                                                                                                                                                                                                                                • RRP = never
                                                                                                                                                                                                                                                                                                                                • RJP = never
                                                                                                                                                                                                                                                                                                                                • RNP = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                    ARD
                                                                                                                                                                                                                                                                                                                                    | ARF
                                                                                                                                                                                                                                                                                                                                    | ARP,
                                                                                                                                                                                                                                                                                                                                    AJD | AJF | AJP,
                                                                                                                                                                                                                                                                                                                                    AND | ANF | ANP,
                                                                                                                                                                                                                                                                                                                                    BRD | BRF | BRP,
                                                                                                                                                                                                                                                                                                                                    BJD | BJF | BJP,
                                                                                                                                                                                                                                                                                                                                    BND | BNF | BNP,
                                                                                                                                                                                                                                                                                                                                    CRD | CRF | CRP,
                                                                                                                                                                                                                                                                                                                                    CJD | CJF | CJP,
                                                                                                                                                                                                                                                                                                                                    CND | CNF | CNP,
                                                                                                                                                                                                                                                                                                                                    RRD | RRF | RRP,
                                                                                                                                                                                                                                                                                                                                    RJD | RJF | RJP,
                                                                                                                                                                                                                                                                                                                                    RND | RNF | RNP,
                                                                                                                                                                                                                                                                                                                                >

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.8

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method. +```javascript +$.get( "test.php" ).then( +function() { +alert( "$.get succeeded" ); +}, function() { +alert( "$.get failed!" ); +} +); +``` +@example ​ ````Filter the resolve value:

                                                                                                                                                                                                                                                                                                                                <!doctype html>
                                                                                                                                                                                                                                                                                                                                <html lang="en">
                                                                                                                                                                                                                                                                                                                                <head>
                                                                                                                                                                                                                                                                                                                                <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                <title>deferred.then demo</title>
                                                                                                                                                                                                                                                                                                                                <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                </head>
                                                                                                                                                                                                                                                                                                                                <body>
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                <button>Filter Resolve</button>
                                                                                                                                                                                                                                                                                                                                <p></p>
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                <script>
                                                                                                                                                                                                                                                                                                                                var filterResolve = function() {
                                                                                                                                                                                                                                                                                                                                var defer = $.Deferred(),
                                                                                                                                                                                                                                                                                                                                filtered = defer.then(function( value ) {
                                                                                                                                                                                                                                                                                                                                return value * 2;
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                defer.resolve( 5 );
                                                                                                                                                                                                                                                                                                                                filtered.done(function( value ) {
                                                                                                                                                                                                                                                                                                                                $( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                $( "button" ).on( "click", filterResolve );
                                                                                                                                                                                                                                                                                                                                </script>
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                </body>
                                                                                                                                                                                                                                                                                                                                </html>
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.then( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARF = never
                                                                                                                                                                                                                                                                                                                                • AJF = never
                                                                                                                                                                                                                                                                                                                                • ANF = never
                                                                                                                                                                                                                                                                                                                                • BRF = never
                                                                                                                                                                                                                                                                                                                                • BJF = never
                                                                                                                                                                                                                                                                                                                                • BNF = never
                                                                                                                                                                                                                                                                                                                                • CRF = never
                                                                                                                                                                                                                                                                                                                                • CJF = never
                                                                                                                                                                                                                                                                                                                                • CNF = never
                                                                                                                                                                                                                                                                                                                                • RRF = never
                                                                                                                                                                                                                                                                                                                                • RJF = never
                                                                                                                                                                                                                                                                                                                                • RNF = never
                                                                                                                                                                                                                                                                                                                                • ARP = never
                                                                                                                                                                                                                                                                                                                                • AJP = never
                                                                                                                                                                                                                                                                                                                                • ANP = never
                                                                                                                                                                                                                                                                                                                                • BRP = never
                                                                                                                                                                                                                                                                                                                                • BJP = never
                                                                                                                                                                                                                                                                                                                                • BNP = never
                                                                                                                                                                                                                                                                                                                                • CRP = never
                                                                                                                                                                                                                                                                                                                                • CJP = never
                                                                                                                                                                                                                                                                                                                                • CNP = never
                                                                                                                                                                                                                                                                                                                                • RRP = never
                                                                                                                                                                                                                                                                                                                                • RJP = never
                                                                                                                                                                                                                                                                                                                                • RNP = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • doneFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • failFilter: (
                                                                                                                                                                                                                                                                                                                                      t: any,
                                                                                                                                                                                                                                                                                                                                      u: any,
                                                                                                                                                                                                                                                                                                                                      v: any,
                                                                                                                                                                                                                                                                                                                                      ...s: any[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ARF
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ARF>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • progressFilter: (
                                                                                                                                                                                                                                                                                                                                      t: any,
                                                                                                                                                                                                                                                                                                                                      u: any,
                                                                                                                                                                                                                                                                                                                                      v: any,
                                                                                                                                                                                                                                                                                                                                      ...s: any[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ANP
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ANP>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                    ARF
                                                                                                                                                                                                                                                                                                                                    | ARP,
                                                                                                                                                                                                                                                                                                                                    AJF | AJP,
                                                                                                                                                                                                                                                                                                                                    ANF | ANP,
                                                                                                                                                                                                                                                                                                                                    BRF | BRP,
                                                                                                                                                                                                                                                                                                                                    BJF | BJP,
                                                                                                                                                                                                                                                                                                                                    BNF | BNP,
                                                                                                                                                                                                                                                                                                                                    CRF | CRP,
                                                                                                                                                                                                                                                                                                                                    CJF | CJP,
                                                                                                                                                                                                                                                                                                                                    CNF | CNP,
                                                                                                                                                                                                                                                                                                                                    RRF | RRP,
                                                                                                                                                                                                                                                                                                                                    RJF | RJP,
                                                                                                                                                                                                                                                                                                                                    RNF | RNP,
                                                                                                                                                                                                                                                                                                                                >

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.8

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.then( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARD = never
                                                                                                                                                                                                                                                                                                                                • AJD = never
                                                                                                                                                                                                                                                                                                                                • AND = never
                                                                                                                                                                                                                                                                                                                                • BRD = never
                                                                                                                                                                                                                                                                                                                                • BJD = never
                                                                                                                                                                                                                                                                                                                                • BND = never
                                                                                                                                                                                                                                                                                                                                • CRD = never
                                                                                                                                                                                                                                                                                                                                • CJD = never
                                                                                                                                                                                                                                                                                                                                • CND = never
                                                                                                                                                                                                                                                                                                                                • RRD = never
                                                                                                                                                                                                                                                                                                                                • RJD = never
                                                                                                                                                                                                                                                                                                                                • RND = never
                                                                                                                                                                                                                                                                                                                                • ARP = never
                                                                                                                                                                                                                                                                                                                                • AJP = never
                                                                                                                                                                                                                                                                                                                                • ANP = never
                                                                                                                                                                                                                                                                                                                                • BRP = never
                                                                                                                                                                                                                                                                                                                                • BJP = never
                                                                                                                                                                                                                                                                                                                                • BNP = never
                                                                                                                                                                                                                                                                                                                                • CRP = never
                                                                                                                                                                                                                                                                                                                                • CJP = never
                                                                                                                                                                                                                                                                                                                                • CNP = never
                                                                                                                                                                                                                                                                                                                                • RRP = never
                                                                                                                                                                                                                                                                                                                                • RJP = never
                                                                                                                                                                                                                                                                                                                                • RNP = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • doneFilter: (
                                                                                                                                                                                                                                                                                                                                      t: T,
                                                                                                                                                                                                                                                                                                                                      u: T,
                                                                                                                                                                                                                                                                                                                                      v: T,
                                                                                                                                                                                                                                                                                                                                      ...s: T[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ARD
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ARD>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • failFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • progressFilter: (
                                                                                                                                                                                                                                                                                                                                      t: any,
                                                                                                                                                                                                                                                                                                                                      u: any,
                                                                                                                                                                                                                                                                                                                                      v: any,
                                                                                                                                                                                                                                                                                                                                      ...s: any[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ANP
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ANP>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                    ARD
                                                                                                                                                                                                                                                                                                                                    | ARP,
                                                                                                                                                                                                                                                                                                                                    AJD | AJP,
                                                                                                                                                                                                                                                                                                                                    AND | ANP,
                                                                                                                                                                                                                                                                                                                                    BRD | BRP,
                                                                                                                                                                                                                                                                                                                                    BJD | BJP,
                                                                                                                                                                                                                                                                                                                                    BND | BNP,
                                                                                                                                                                                                                                                                                                                                    CRD | CRP,
                                                                                                                                                                                                                                                                                                                                    CJD | CJP,
                                                                                                                                                                                                                                                                                                                                    CND | CNP,
                                                                                                                                                                                                                                                                                                                                    RRD | RRP,
                                                                                                                                                                                                                                                                                                                                    RJD | RJP,
                                                                                                                                                                                                                                                                                                                                    RND | RNP,
                                                                                                                                                                                                                                                                                                                                >

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.8

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Filter the resolve value: +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>deferred.then demo</title> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<button>Filter Resolve</button> +<p></p> +​ +<script> +var filterResolve = function() { +var defer = $.Deferred(), +filtered = defer.then(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +$( "p" ).html( "Value is ( 2*5 = ) 10: " + value ); +}); +}; +​ +$( "button" ).on( "click", filterResolve ); +</script> +​ +</body> +</html> +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARP = never
                                                                                                                                                                                                                                                                                                                                • AJP = never
                                                                                                                                                                                                                                                                                                                                • ANP = never
                                                                                                                                                                                                                                                                                                                                • BRP = never
                                                                                                                                                                                                                                                                                                                                • BJP = never
                                                                                                                                                                                                                                                                                                                                • BNP = never
                                                                                                                                                                                                                                                                                                                                • CRP = never
                                                                                                                                                                                                                                                                                                                                • CJP = never
                                                                                                                                                                                                                                                                                                                                • CNP = never
                                                                                                                                                                                                                                                                                                                                • RRP = never
                                                                                                                                                                                                                                                                                                                                • RJP = never
                                                                                                                                                                                                                                                                                                                                • RNP = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • doneFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • failFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalprogressFilter: (
                                                                                                                                                                                                                                                                                                                                      t: any,
                                                                                                                                                                                                                                                                                                                                      u: any,
                                                                                                                                                                                                                                                                                                                                      v: any,
                                                                                                                                                                                                                                                                                                                                      ...s: any[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ANP
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ANP>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.8

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARD = never
                                                                                                                                                                                                                                                                                                                                • AJD = never
                                                                                                                                                                                                                                                                                                                                • AND = never
                                                                                                                                                                                                                                                                                                                                • BRD = never
                                                                                                                                                                                                                                                                                                                                • BJD = never
                                                                                                                                                                                                                                                                                                                                • BND = never
                                                                                                                                                                                                                                                                                                                                • CRD = never
                                                                                                                                                                                                                                                                                                                                • CJD = never
                                                                                                                                                                                                                                                                                                                                • CND = never
                                                                                                                                                                                                                                                                                                                                • RRD = never
                                                                                                                                                                                                                                                                                                                                • RJD = never
                                                                                                                                                                                                                                                                                                                                • RND = never
                                                                                                                                                                                                                                                                                                                                • ARF = never
                                                                                                                                                                                                                                                                                                                                • AJF = never
                                                                                                                                                                                                                                                                                                                                • ANF = never
                                                                                                                                                                                                                                                                                                                                • BRF = never
                                                                                                                                                                                                                                                                                                                                • BJF = never
                                                                                                                                                                                                                                                                                                                                • BNF = never
                                                                                                                                                                                                                                                                                                                                • CRF = never
                                                                                                                                                                                                                                                                                                                                • CJF = never
                                                                                                                                                                                                                                                                                                                                • CNF = never
                                                                                                                                                                                                                                                                                                                                • RRF = never
                                                                                                                                                                                                                                                                                                                                • RJF = never
                                                                                                                                                                                                                                                                                                                                • RNF = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • doneFilter: (
                                                                                                                                                                                                                                                                                                                                      t: T,
                                                                                                                                                                                                                                                                                                                                      u: T,
                                                                                                                                                                                                                                                                                                                                      v: T,
                                                                                                                                                                                                                                                                                                                                      ...s: T[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ARD
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ARD>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • failFilter: (
                                                                                                                                                                                                                                                                                                                                      t: any,
                                                                                                                                                                                                                                                                                                                                      u: any,
                                                                                                                                                                                                                                                                                                                                      v: any,
                                                                                                                                                                                                                                                                                                                                      ...s: any[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ARF
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ARF>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalprogressFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                    ARD
                                                                                                                                                                                                                                                                                                                                    | ARF,
                                                                                                                                                                                                                                                                                                                                    AJD | AJF,
                                                                                                                                                                                                                                                                                                                                    AND | ANF,
                                                                                                                                                                                                                                                                                                                                    BRD | BRF,
                                                                                                                                                                                                                                                                                                                                    BJD | BJF,
                                                                                                                                                                                                                                                                                                                                    BND | BNF,
                                                                                                                                                                                                                                                                                                                                    CRD | CRF,
                                                                                                                                                                                                                                                                                                                                    CJD | CJF,
                                                                                                                                                                                                                                                                                                                                    CND | CNF,
                                                                                                                                                                                                                                                                                                                                    RRD | RRF,
                                                                                                                                                                                                                                                                                                                                    RJD | RJF,
                                                                                                                                                                                                                                                                                                                                    RND | RNF,
                                                                                                                                                                                                                                                                                                                                >

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.8

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method. +```javascript +$.get( "test.php" ).then( +function() { +alert( "$.get succeeded" ); +}, function() { +alert( "$.get failed!" ); +} +); +``` +@example ​ ````Filter the resolve value:

                                                                                                                                                                                                                                                                                                                                <!doctype html>
                                                                                                                                                                                                                                                                                                                                <html lang="en">
                                                                                                                                                                                                                                                                                                                                <head>
                                                                                                                                                                                                                                                                                                                                <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                <title>deferred.then demo</title>
                                                                                                                                                                                                                                                                                                                                <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                </head>
                                                                                                                                                                                                                                                                                                                                <body>
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                <button>Filter Resolve</button>
                                                                                                                                                                                                                                                                                                                                <p></p>
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                <script>
                                                                                                                                                                                                                                                                                                                                var filterResolve = function() {
                                                                                                                                                                                                                                                                                                                                var defer = $.Deferred(),
                                                                                                                                                                                                                                                                                                                                filtered = defer.then(function( value ) {
                                                                                                                                                                                                                                                                                                                                return value * 2;
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                defer.resolve( 5 );
                                                                                                                                                                                                                                                                                                                                filtered.done(function( value ) {
                                                                                                                                                                                                                                                                                                                                $( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                $( "button" ).on( "click", filterResolve );
                                                                                                                                                                                                                                                                                                                                </script>
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                </body>
                                                                                                                                                                                                                                                                                                                                </html>
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.then( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARF = never
                                                                                                                                                                                                                                                                                                                                • AJF = never
                                                                                                                                                                                                                                                                                                                                • ANF = never
                                                                                                                                                                                                                                                                                                                                • BRF = never
                                                                                                                                                                                                                                                                                                                                • BJF = never
                                                                                                                                                                                                                                                                                                                                • BNF = never
                                                                                                                                                                                                                                                                                                                                • CRF = never
                                                                                                                                                                                                                                                                                                                                • CJF = never
                                                                                                                                                                                                                                                                                                                                • CNF = never
                                                                                                                                                                                                                                                                                                                                • RRF = never
                                                                                                                                                                                                                                                                                                                                • RJF = never
                                                                                                                                                                                                                                                                                                                                • RNF = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • doneFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • failFilter: (
                                                                                                                                                                                                                                                                                                                                      t: any,
                                                                                                                                                                                                                                                                                                                                      u: any,
                                                                                                                                                                                                                                                                                                                                      v: any,
                                                                                                                                                                                                                                                                                                                                      ...s: any[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ARF
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ARF>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalprogressFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.8

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.then( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                • ARD = never
                                                                                                                                                                                                                                                                                                                                • AJD = never
                                                                                                                                                                                                                                                                                                                                • AND = never
                                                                                                                                                                                                                                                                                                                                • BRD = never
                                                                                                                                                                                                                                                                                                                                • BJD = never
                                                                                                                                                                                                                                                                                                                                • BND = never
                                                                                                                                                                                                                                                                                                                                • CRD = never
                                                                                                                                                                                                                                                                                                                                • CJD = never
                                                                                                                                                                                                                                                                                                                                • CND = never
                                                                                                                                                                                                                                                                                                                                • RRD = never
                                                                                                                                                                                                                                                                                                                                • RJD = never
                                                                                                                                                                                                                                                                                                                                • RND = never

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • doneFilter: (
                                                                                                                                                                                                                                                                                                                                      t: T,
                                                                                                                                                                                                                                                                                                                                      u: T,
                                                                                                                                                                                                                                                                                                                                      v: T,
                                                                                                                                                                                                                                                                                                                                      ...s: T[],
                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                      | ARD
                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                      | Thenable<ARD>

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalfailFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalprogressFilter: null

                                                                                                                                                                                                                                                                                                                                  An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>

                                                                                                                                                                                                                                                                                                                                <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                1.8

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Example: ​ ````Filter the resolve value: +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>deferred.then demo</title> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<button>Filter Resolve</button> +<p></p> +​ +<script> +var filterResolve = function() { +var defer = $.Deferred(), +filtered = defer.then(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +$( "p" ).html( "Value is ( 2*5 = ) 10: " + value ); +}); +}; +​ +$( "button" ).on( "click", filterResolve ); +</script> +​ +</body> +</html> +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                ​
                                                                                                                                                                                                                                                                                                                                chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.List.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.List.html new file mode 100644 index 000000000..c7a38e70f --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.List.html @@ -0,0 +1,4 @@ +List | trilium
                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                Interface List

                                                                                                                                                                                                                                                                                                                                interface List {
                                                                                                                                                                                                                                                                                                                                    dnd5?: DragAndDrop5;
                                                                                                                                                                                                                                                                                                                                    filter?: Filter;
                                                                                                                                                                                                                                                                                                                                    table?: Table;
                                                                                                                                                                                                                                                                                                                                    [extension: string]: any;
                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                • [extension: string]: any
                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                dnd5? +filter? +table? +

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                dnd5?: DragAndDrop5
                                                                                                                                                                                                                                                                                                                                filter?: Filter
                                                                                                                                                                                                                                                                                                                                table?: Table

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Marker.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Marker.html new file mode 100644 index 000000000..b274de34d --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Marker.html @@ -0,0 +1,2 @@ +Marker | trilium
                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                  Interface Marker

                                                                                                                                                                                                                                                                                                                                  interface Marker {
                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  name +

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  name: string

                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.MentionConfig.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.MentionConfig.html new file mode 100644 index 000000000..c92ba9d97 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.MentionConfig.html @@ -0,0 +1,2 @@ +MentionConfig | trilium
                                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                    Interface MentionConfig

                                                                                                                                                                                                                                                                                                                                    interface MentionConfig {
                                                                                                                                                                                                                                                                                                                                        feeds: {
                                                                                                                                                                                                                                                                                                                                            feed: (queryText: string) => MentionItem[] | Promise<MentionItem[]>;
                                                                                                                                                                                                                                                                                                                                            itemRenderer?: (item: { highlightedNotePathTitle: string }) => void;
                                                                                                                                                                                                                                                                                                                                            marker: string;
                                                                                                                                                                                                                                                                                                                                            minimumCharacters: number;
                                                                                                                                                                                                                                                                                                                                        }[];
                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    feeds +

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    feeds: {
                                                                                                                                                                                                                                                                                                                                        feed: (queryText: string) => MentionItem[] | Promise<MentionItem[]>;
                                                                                                                                                                                                                                                                                                                                        itemRenderer?: (item: { highlightedNotePathTitle: string }) => void;
                                                                                                                                                                                                                                                                                                                                        marker: string;
                                                                                                                                                                                                                                                                                                                                        minimumCharacters: number;
                                                                                                                                                                                                                                                                                                                                    }[]

                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.MentionItem.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.MentionItem.html new file mode 100644 index 000000000..92ed4edea --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.MentionItem.html @@ -0,0 +1,8 @@ +MentionItem | trilium
                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                      Interface MentionItem

                                                                                                                                                                                                                                                                                                                                      interface MentionItem {
                                                                                                                                                                                                                                                                                                                                          action?: string;
                                                                                                                                                                                                                                                                                                                                          highlightedNotePathTitle?: string;
                                                                                                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                                                                                                          link?: string;
                                                                                                                                                                                                                                                                                                                                          name: string;
                                                                                                                                                                                                                                                                                                                                          notePath?: string;
                                                                                                                                                                                                                                                                                                                                          noteTitle?: string;
                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      action? +highlightedNotePathTitle? +id +link? +name +notePath? +noteTitle? +

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      action?: string
                                                                                                                                                                                                                                                                                                                                      highlightedNotePathTitle?: string
                                                                                                                                                                                                                                                                                                                                      id: string
                                                                                                                                                                                                                                                                                                                                      link?: string
                                                                                                                                                                                                                                                                                                                                      name: string
                                                                                                                                                                                                                                                                                                                                      notePath?: string
                                                                                                                                                                                                                                                                                                                                      noteTitle?: string

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.MouseDownEvent.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.MouseDownEvent.html new file mode 100644 index 000000000..ba42c83a1 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.MouseDownEvent.html @@ -0,0 +1,219 @@ +MouseDownEvent | trilium
                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                        Interface MouseDownEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>

                                                                                                                                                                                                                                                                                                                                        Base type for jQuery events that have been triggered (including events triggered on plain objects).

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        interface MouseDownEvent<
                                                                                                                                                                                                                                                                                                                                            TDelegateTarget = any,
                                                                                                                                                                                                                                                                                                                                            TData = any,
                                                                                                                                                                                                                                                                                                                                            TCurrentTarget = any,
                                                                                                                                                                                                                                                                                                                                            TTarget = any,
                                                                                                                                                                                                                                                                                                                                        > {
                                                                                                                                                                                                                                                                                                                                            altKey: boolean;
                                                                                                                                                                                                                                                                                                                                            bubbles: boolean;
                                                                                                                                                                                                                                                                                                                                            button: number;
                                                                                                                                                                                                                                                                                                                                            buttons: number;
                                                                                                                                                                                                                                                                                                                                            cancelable: boolean;
                                                                                                                                                                                                                                                                                                                                            changedTouches: undefined;
                                                                                                                                                                                                                                                                                                                                            char: undefined;
                                                                                                                                                                                                                                                                                                                                            charCode: undefined;
                                                                                                                                                                                                                                                                                                                                            clientX: number;
                                                                                                                                                                                                                                                                                                                                            clientY: number;
                                                                                                                                                                                                                                                                                                                                            ctrlKey: boolean;
                                                                                                                                                                                                                                                                                                                                            currentTarget: TCurrentTarget;
                                                                                                                                                                                                                                                                                                                                            data: TData;
                                                                                                                                                                                                                                                                                                                                            delegateTarget: TDelegateTarget;
                                                                                                                                                                                                                                                                                                                                            detail: number;
                                                                                                                                                                                                                                                                                                                                            eventPhase: number;
                                                                                                                                                                                                                                                                                                                                            key: undefined;
                                                                                                                                                                                                                                                                                                                                            keyCode: undefined;
                                                                                                                                                                                                                                                                                                                                            metaKey: boolean;
                                                                                                                                                                                                                                                                                                                                            namespace?: string;
                                                                                                                                                                                                                                                                                                                                            offsetX: number;
                                                                                                                                                                                                                                                                                                                                            offsetY: number;
                                                                                                                                                                                                                                                                                                                                            originalEvent?: MouseEvent;
                                                                                                                                                                                                                                                                                                                                            pageX: number;
                                                                                                                                                                                                                                                                                                                                            pageY: number;
                                                                                                                                                                                                                                                                                                                                            pointerId: undefined;
                                                                                                                                                                                                                                                                                                                                            pointerType: undefined;
                                                                                                                                                                                                                                                                                                                                            relatedTarget?: null;
                                                                                                                                                                                                                                                                                                                                            result?: any;
                                                                                                                                                                                                                                                                                                                                            screenX: number;
                                                                                                                                                                                                                                                                                                                                            screenY: number;
                                                                                                                                                                                                                                                                                                                                            shiftKey: boolean;
                                                                                                                                                                                                                                                                                                                                            target: TTarget;
                                                                                                                                                                                                                                                                                                                                            targetTouches: undefined;
                                                                                                                                                                                                                                                                                                                                            timeStamp: number;
                                                                                                                                                                                                                                                                                                                                            toElement: Element;
                                                                                                                                                                                                                                                                                                                                            touches: undefined;
                                                                                                                                                                                                                                                                                                                                            type: "mousedown";
                                                                                                                                                                                                                                                                                                                                            view: Window;
                                                                                                                                                                                                                                                                                                                                            which: number;
                                                                                                                                                                                                                                                                                                                                            isDefaultPrevented(): boolean;
                                                                                                                                                                                                                                                                                                                                            isImmediatePropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                                            isPropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                                            preventDefault(): void;
                                                                                                                                                                                                                                                                                                                                            stopImmediatePropagation(): void;
                                                                                                                                                                                                                                                                                                                                            stopPropagation(): void;
                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                        • TDelegateTarget = any
                                                                                                                                                                                                                                                                                                                                        • TData = any
                                                                                                                                                                                                                                                                                                                                        • TCurrentTarget = any
                                                                                                                                                                                                                                                                                                                                        • TTarget = any

                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        altKey +bubbles +button +buttons +cancelable +changedTouches +char +charCode +clientX +clientY +ctrlKey +currentTarget +data +delegateTarget +detail +eventPhase +key +keyCode +metaKey +namespace? +offsetX +offsetY +originalEvent? +pageX +pageY +pointerId +pointerType +relatedTarget? +result? +screenX +screenY +shiftKey +target +targetTouches +timeStamp +toElement +touches +type +view +which +

                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                        isDefaultPrevented +isImmediatePropagationStopped +isPropagationStopped +preventDefault +stopImmediatePropagation +stopPropagation +

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        altKey: boolean
                                                                                                                                                                                                                                                                                                                                        bubbles: boolean
                                                                                                                                                                                                                                                                                                                                        button: number
                                                                                                                                                                                                                                                                                                                                        buttons: number
                                                                                                                                                                                                                                                                                                                                        cancelable: boolean
                                                                                                                                                                                                                                                                                                                                        changedTouches: undefined
                                                                                                                                                                                                                                                                                                                                        char: undefined
                                                                                                                                                                                                                                                                                                                                        charCode: undefined
                                                                                                                                                                                                                                                                                                                                        clientX: number
                                                                                                                                                                                                                                                                                                                                        clientY: number
                                                                                                                                                                                                                                                                                                                                        ctrlKey: boolean
                                                                                                                                                                                                                                                                                                                                        currentTarget: TCurrentTarget

                                                                                                                                                                                                                                                                                                                                        The current DOM element within the event bubbling phase.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.currentTarget/">https://api.jquery.com/event.currentTarget/</a>

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        1.3

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Alert that currentTarget matches the `this` keyword.

                                                                                                                                                                                                                                                                                                                                        $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                        alert( event.currentTarget === this ); // true
                                                                                                                                                                                                                                                                                                                                        });
+
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        data: TData

                                                                                                                                                                                                                                                                                                                                        An optional object of data passed to an event method when the current executing handler is bound.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.data/">https://api.jquery.com/event.data/</a>

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        1.1

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Within a for loop, pass the value of i to the .on() method so that the current iteration&#39;s value is preserved.

                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                        <title>event.data demo</title>
                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <button> 0 </button>
                                                                                                                                                                                                                                                                                                                                        <button> 1 </button>
                                                                                                                                                                                                                                                                                                                                        <button> 2 </button>
                                                                                                                                                                                                                                                                                                                                        <button> 3 </button>
                                                                                                                                                                                                                                                                                                                                        <button> 4 </button>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                        var logDiv = $( "#log" );
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        for ( var i = 0; i < 5; i++ ) {
                                                                                                                                                                                                                                                                                                                                        $( "button" ).eq( i ).on( "click", { value: i }, function( event ) {
                                                                                                                                                                                                                                                                                                                                        var msgs = [
                                                                                                                                                                                                                                                                                                                                        "button = " + $( this ).index(),
                                                                                                                                                                                                                                                                                                                                        "event.data.value = " + event.data.value,
                                                                                                                                                                                                                                                                                                                                        "i = " + i
                                                                                                                                                                                                                                                                                                                                        ];
                                                                                                                                                                                                                                                                                                                                        logDiv.append( msgs.join( ", " ) + "<br>" );
                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        delegateTarget: TDelegateTarget

                                                                                                                                                                                                                                                                                                                                        The element where the currently-called jQuery event handler was attached.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.delegateTarget/">https://api.jquery.com/event.delegateTarget/</a>

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        1.7

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Example: ​ ````When a button in any box class is clicked, change the box&#39;s background color to red.

                                                                                                                                                                                                                                                                                                                                        $( ".box" ).on( "click", "button", function( event ) {
                                                                                                                                                                                                                                                                                                                                        $( event.delegateTarget ).css( "background-color", "red" );
                                                                                                                                                                                                                                                                                                                                        });
+
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        detail: number
                                                                                                                                                                                                                                                                                                                                        eventPhase: number
                                                                                                                                                                                                                                                                                                                                        key: undefined
                                                                                                                                                                                                                                                                                                                                        keyCode: undefined
                                                                                                                                                                                                                                                                                                                                        metaKey: boolean

                                                                                                                                                                                                                                                                                                                                        Indicates whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.metaKey/">https://api.jquery.com/event.metaKey/</a>

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        1.0.4

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Determine whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                        <title>event.metaKey demo</title>
                                                                                                                                                                                                                                                                                                                                        <style>
                                                                                                                                                                                                                                                                                                                                        body {
                                                                                                                                                                                                                                                                                                                                        background-color: #eef;
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        div {
                                                                                                                                                                                                                                                                                                                                        padding: 20px;
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        </style>
                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <button value="Test" name="Test" id="checkMetaKey">Click me!</button>
                                                                                                                                                                                                                                                                                                                                        <div id="display"></div>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                        $( "#checkMetaKey" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                        $( "#display" ).text( event.metaKey );
                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        namespace?: string

                                                                                                                                                                                                                                                                                                                                        The namespace specified when the event was triggered.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.namespace/">https://api.jquery.com/event.namespace/</a>

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        1.4.3

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Determine the event namespace used.

                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                        <title>event.namespace demo</title>
                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <button>display event.namespace</button>
                                                                                                                                                                                                                                                                                                                                        <p></p>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                        $( "p" ).on( "test.something", function( event ) {
                                                                                                                                                                                                                                                                                                                                        alert( event.namespace );
                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                        $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                        $( "p" ).trigger( "test.something" );
                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        offsetX: number
                                                                                                                                                                                                                                                                                                                                        offsetY: number
                                                                                                                                                                                                                                                                                                                                        originalEvent?: MouseEvent
                                                                                                                                                                                                                                                                                                                                        pageX: number

                                                                                                                                                                                                                                                                                                                                        The mouse position relative to the left edge of the document.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.pageX/">https://api.jquery.com/event.pageX/</a>

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        1.0.4

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe).

                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                        <title>event.pageX demo</title>
                                                                                                                                                                                                                                                                                                                                        <style>
                                                                                                                                                                                                                                                                                                                                        body {
                                                                                                                                                                                                                                                                                                                                        background-color: #eef;
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        div {
                                                                                                                                                                                                                                                                                                                                        padding: 20px;
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        </style>
                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                        $( document ).on( "mousemove", function( event ) {
                                                                                                                                                                                                                                                                                                                                        $( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        pageY: number

                                                                                                                                                                                                                                                                                                                                        The mouse position relative to the top edge of the document.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.pageY/">https://api.jquery.com/event.pageY/</a>

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        1.0.4

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe).

                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                        <title>event.pageY demo</title>
                                                                                                                                                                                                                                                                                                                                        <style>
                                                                                                                                                                                                                                                                                                                                        body {
                                                                                                                                                                                                                                                                                                                                        background-color: #eef;
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        div {
                                                                                                                                                                                                                                                                                                                                        padding: 20px;
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        </style>
                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                        $( document ).on( "mousemove", function( event ) {
                                                                                                                                                                                                                                                                                                                                        $( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        pointerId: undefined
                                                                                                                                                                                                                                                                                                                                        pointerType: undefined
                                                                                                                                                                                                                                                                                                                                        relatedTarget?: null

                                                                                                                                                                                                                                                                                                                                        The other DOM element involved in the event, if any.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.relatedTarget/">https://api.jquery.com/event.relatedTarget/</a>

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        1.1.4

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Example: ​ ````On mouseout of anchors, alert the element type being entered.

                                                                                                                                                                                                                                                                                                                                        $( "a" ).mouseout(function( event ) {
                                                                                                                                                                                                                                                                                                                                        alert( event.relatedTarget.nodeName ); // "DIV"
                                                                                                                                                                                                                                                                                                                                        });
+
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        result?: any

                                                                                                                                                                                                                                                                                                                                        The last value returned by an event handler that was triggered by this event, unless the value was undefined.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.result/">https://api.jquery.com/event.result/</a>

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        1.3

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Display previous handler&#39;s return value

                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                        <title>event.result demo</title>
                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <button>display event.result</button>
                                                                                                                                                                                                                                                                                                                                        <p></p>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                        $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                        return "hey";
                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                        $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                        $( "p" ).html( event.result );
                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        screenX: number
                                                                                                                                                                                                                                                                                                                                        screenY: number
                                                                                                                                                                                                                                                                                                                                        shiftKey: boolean
                                                                                                                                                                                                                                                                                                                                        target: TTarget

                                                                                                                                                                                                                                                                                                                                        The DOM element that initiated the event.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.target/">https://api.jquery.com/event.target/</a>

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        1.0

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Display the tag&#39;s name on click +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>event.target demo</title> +<style> +span, strong, p { +padding: 8px; +display: block; +border: 1px solid #999; +} +</style> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<div id="log"></div> +<div> +<p> +<strong><span>click</span></strong> +</p> +</div> +​ +<script> +$( "body" ).click(function( event ) { +$( "#log" ).html( "clicked: " + event.target.nodeName ); +}); +</script> +​ +</body> +</html> +``` +@example ​ ````Implements a simple event delegation: The click handler is added to an unordered list, and the children of its li children are hidden. Clicking one of the li children toggles (see toggle()) their children.

                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                        <title>event.target demo</title>
                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <ul>
                                                                                                                                                                                                                                                                                                                                        <li>item 1
                                                                                                                                                                                                                                                                                                                                        <ul>
                                                                                                                                                                                                                                                                                                                                        <li>sub item 1-a</li>
                                                                                                                                                                                                                                                                                                                                        <li>sub item 1-b</li>
                                                                                                                                                                                                                                                                                                                                        </ul>
                                                                                                                                                                                                                                                                                                                                        </li>
                                                                                                                                                                                                                                                                                                                                        <li>item 2
                                                                                                                                                                                                                                                                                                                                        <ul>
                                                                                                                                                                                                                                                                                                                                        <li>sub item 2-a</li>
                                                                                                                                                                                                                                                                                                                                        <li>sub item 2-b</li>
                                                                                                                                                                                                                                                                                                                                        </ul>
                                                                                                                                                                                                                                                                                                                                        </li>
                                                                                                                                                                                                                                                                                                                                        </ul>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                        function handler( event ) {
                                                                                                                                                                                                                                                                                                                                        var target = $( event.target );
                                                                                                                                                                                                                                                                                                                                        if ( target.is( "li" ) ) {
                                                                                                                                                                                                                                                                                                                                        target.children().toggle();
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        $( "ul" ).click( handler ).find( "ul" ).hide();
                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        targetTouches: undefined
                                                                                                                                                                                                                                                                                                                                        timeStamp: number

                                                                                                                                                                                                                                                                                                                                        The difference in milliseconds between the time the browser created the event and January 1, 1970.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.timeStamp/">https://api.jquery.com/event.timeStamp/</a>

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        1.2.6

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Display the time since the click handler last executed.

                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                        <title>event.timeStamp demo</title>
                                                                                                                                                                                                                                                                                                                                        <style>
                                                                                                                                                                                                                                                                                                                                        div {
                                                                                                                                                                                                                                                                                                                                        height: 100px;
                                                                                                                                                                                                                                                                                                                                        width: 300px;
                                                                                                                                                                                                                                                                                                                                        margin: 10px;
                                                                                                                                                                                                                                                                                                                                        background-color: #ffd;
                                                                                                                                                                                                                                                                                                                                        overflow: auto;
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        </style>
                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <div>Click.</div>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                        var last, diff;
                                                                                                                                                                                                                                                                                                                                        $( "div" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                        if ( last ) {
                                                                                                                                                                                                                                                                                                                                        diff = event.timeStamp - last;
                                                                                                                                                                                                                                                                                                                                        $( "div" ).append( "time since last event: " + diff + "<br>" );
                                                                                                                                                                                                                                                                                                                                        } else {
                                                                                                                                                                                                                                                                                                                                        $( "div" ).append( "Click again.<br>" );
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        last = event.timeStamp;
                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        toElement: Element
                                                                                                                                                                                                                                                                                                                                        touches: undefined
                                                                                                                                                                                                                                                                                                                                        type: "mousedown"

                                                                                                                                                                                                                                                                                                                                        Describes the nature of the event.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.type/">https://api.jquery.com/event.type/</a>

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        1.0

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Example: ​ ````On all anchor clicks, alert the event type.

                                                                                                                                                                                                                                                                                                                                        $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                        alert( event.type ); // "click"
                                                                                                                                                                                                                                                                                                                                        });
+
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        view: Window
                                                                                                                                                                                                                                                                                                                                        which: number

                                                                                                                                                                                                                                                                                                                                        For key or mouse events, this property indicates the specific key or button that was pressed.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.which/">https://api.jquery.com/event.which/</a>

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        1.1.3

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Log which key was depressed. +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>event.which demo</title> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<input id="whichkey" value="type something"> +<div id="log"></div> +​ +<script> +$( "#whichkey" ).on( "keydown", function( event ) { +$( "#log" ).html( event.type + ": " + event.which ); +}); +</script> +​ +</body> +</html> +``` +@example ​ ````Log which mouse button was depressed.

                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                        <title>event.which demo</title>
                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <input id="whichkey" value="click here">
                                                                                                                                                                                                                                                                                                                                        <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                        $( "#whichkey" ).on( "mousedown", function( event ) {
                                                                                                                                                                                                                                                                                                                                        $( "#log" ).html( event.type + ": " +  event.which );
                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                        • Returns whether event.preventDefault() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.isDefaultPrevented/">https://api.jquery.com/event.isDefaultPrevented/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.3

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Checks whether event.preventDefault() was called.

                                                                                                                                                                                                                                                                                                                                          $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                          alert( event.isDefaultPrevented() ); // false
                                                                                                                                                                                                                                                                                                                                          event.preventDefault();
                                                                                                                                                                                                                                                                                                                                          alert( event.isDefaultPrevented() ); // true
                                                                                                                                                                                                                                                                                                                                          });
+
                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                        • Returns whether event.stopImmediatePropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.isImmediatePropagationStopped/">https://api.jquery.com/event.isImmediatePropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.3

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Checks whether event.stopImmediatePropagation() was called.

                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                          <title>event.isImmediatePropagationStopped demo</title>
                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <button>click me</button>
                                                                                                                                                                                                                                                                                                                                          <div id="stop-log"></div>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                          function immediatePropStopped( event ) {
                                                                                                                                                                                                                                                                                                                                          var msg = "";
                                                                                                                                                                                                                                                                                                                                          if ( event.isImmediatePropagationStopped() ) {
                                                                                                                                                                                                                                                                                                                                          msg = "called";
                                                                                                                                                                                                                                                                                                                                          } else {
                                                                                                                                                                                                                                                                                                                                          msg = "not called";
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          $( "#stop-log" ).append( "<div>" + msg + "</div>" );
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                          immediatePropStopped( event );
                                                                                                                                                                                                                                                                                                                                          event.stopImmediatePropagation();
                                                                                                                                                                                                                                                                                                                                          immediatePropStopped( event );
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                        • Returns whether event.stopPropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.isPropagationStopped/">https://api.jquery.com/event.isPropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.3

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Checks whether event.stopPropagation() was called

                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                          <title>event.isPropagationStopped demo</title>
                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <button>click me</button>
                                                                                                                                                                                                                                                                                                                                          <div id="stop-log"></div>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                          function propStopped( event ) {
                                                                                                                                                                                                                                                                                                                                          var msg = "";
                                                                                                                                                                                                                                                                                                                                          if ( event.isPropagationStopped() ) {
                                                                                                                                                                                                                                                                                                                                          msg = "called";
                                                                                                                                                                                                                                                                                                                                          } else {
                                                                                                                                                                                                                                                                                                                                          msg = "not called";
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          $( "#stop-log" ).append( "<div>" + msg + "</div>" );
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          $( "button" ).click(function(event) {
                                                                                                                                                                                                                                                                                                                                          propStopped( event );
                                                                                                                                                                                                                                                                                                                                          event.stopPropagation();
                                                                                                                                                                                                                                                                                                                                          propStopped( event );
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                        • If this method is called, the default action of the event will not be triggered.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.preventDefault/">https://api.jquery.com/event.preventDefault/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.0

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Cancel the default action (navigation) of the click.

                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                          <title>event.preventDefault demo</title>
                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <a href="https://jquery.com">default click action is prevented</a>
                                                                                                                                                                                                                                                                                                                                          <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                          $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                          event.preventDefault();
                                                                                                                                                                                                                                                                                                                                          $( "<div>" )
                                                                                                                                                                                                                                                                                                                                          .append( "default " + event.type + " prevented" )
                                                                                                                                                                                                                                                                                                                                          .appendTo( "#log" );
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                        • Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.stopImmediatePropagation/">https://api.jquery.com/event.stopImmediatePropagation/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.3

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Prevents other event handlers from being called.

                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                          <title>event.stopImmediatePropagation demo</title>
                                                                                                                                                                                                                                                                                                                                          <style>
                                                                                                                                                                                                                                                                                                                                          p {
                                                                                                                                                                                                                                                                                                                                          height: 30px;
                                                                                                                                                                                                                                                                                                                                          width: 150px;
                                                                                                                                                                                                                                                                                                                                          background-color: #ccf;
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          div {
                                                                                                                                                                                                                                                                                                                                          height: 30px;
                                                                                                                                                                                                                                                                                                                                          width: 150px;
                                                                                                                                                                                                                                                                                                                                          background-color: #cfc;
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          </style>
                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <p>paragraph</p>
                                                                                                                                                                                                                                                                                                                                          <div>division</div>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                          $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                          event.stopImmediatePropagation();
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                          // This function won't be executed
                                                                                                                                                                                                                                                                                                                                          $( this ).css( "background-color", "#f00" );
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          $( "div" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                          // This function will be executed
                                                                                                                                                                                                                                                                                                                                          $( this ).css( "background-color", "#f00" );
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                        • Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.stopPropagation/">https://api.jquery.com/event.stopPropagation/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.0

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Kill the bubbling on the click event.

                                                                                                                                                                                                                                                                                                                                          $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                          event.stopPropagation();
                                                                                                                                                                                                                                                                                                                                          // Do something
                                                                                                                                                                                                                                                                                                                                          });
+
                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.MouseEventBase.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.MouseEventBase.html new file mode 100644 index 000000000..c7ac901a4 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.MouseEventBase.html @@ -0,0 +1,219 @@ +MouseEventBase | trilium
                                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                          Interface MouseEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget>

                                                                                                                                                                                                                                                                                                                                          Base type for jQuery events that have been triggered (including events triggered on plain objects).

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          interface MouseEventBase<
                                                                                                                                                                                                                                                                                                                                              TDelegateTarget = any,
                                                                                                                                                                                                                                                                                                                                              TData = any,
                                                                                                                                                                                                                                                                                                                                              TCurrentTarget = any,
                                                                                                                                                                                                                                                                                                                                              TTarget = any,
                                                                                                                                                                                                                                                                                                                                          > {
                                                                                                                                                                                                                                                                                                                                              altKey: boolean;
                                                                                                                                                                                                                                                                                                                                              bubbles: boolean;
                                                                                                                                                                                                                                                                                                                                              button: number;
                                                                                                                                                                                                                                                                                                                                              buttons: number;
                                                                                                                                                                                                                                                                                                                                              cancelable: boolean;
                                                                                                                                                                                                                                                                                                                                              changedTouches: undefined;
                                                                                                                                                                                                                                                                                                                                              char: undefined;
                                                                                                                                                                                                                                                                                                                                              charCode: undefined;
                                                                                                                                                                                                                                                                                                                                              clientX: number;
                                                                                                                                                                                                                                                                                                                                              clientY: number;
                                                                                                                                                                                                                                                                                                                                              ctrlKey: boolean;
                                                                                                                                                                                                                                                                                                                                              currentTarget: TCurrentTarget;
                                                                                                                                                                                                                                                                                                                                              data: TData;
                                                                                                                                                                                                                                                                                                                                              delegateTarget: TDelegateTarget;
                                                                                                                                                                                                                                                                                                                                              detail: number;
                                                                                                                                                                                                                                                                                                                                              eventPhase: number;
                                                                                                                                                                                                                                                                                                                                              key: undefined;
                                                                                                                                                                                                                                                                                                                                              keyCode: undefined;
                                                                                                                                                                                                                                                                                                                                              metaKey: boolean;
                                                                                                                                                                                                                                                                                                                                              namespace?: string;
                                                                                                                                                                                                                                                                                                                                              offsetX: number;
                                                                                                                                                                                                                                                                                                                                              offsetY: number;
                                                                                                                                                                                                                                                                                                                                              originalEvent?: MouseEvent;
                                                                                                                                                                                                                                                                                                                                              pageX: number;
                                                                                                                                                                                                                                                                                                                                              pageY: number;
                                                                                                                                                                                                                                                                                                                                              pointerId: undefined;
                                                                                                                                                                                                                                                                                                                                              pointerType: undefined;
                                                                                                                                                                                                                                                                                                                                              relatedTarget?: null | EventTarget;
                                                                                                                                                                                                                                                                                                                                              result?: any;
                                                                                                                                                                                                                                                                                                                                              screenX: number;
                                                                                                                                                                                                                                                                                                                                              screenY: number;
                                                                                                                                                                                                                                                                                                                                              shiftKey: boolean;
                                                                                                                                                                                                                                                                                                                                              target: TTarget;
                                                                                                                                                                                                                                                                                                                                              targetTouches: undefined;
                                                                                                                                                                                                                                                                                                                                              timeStamp: number;
                                                                                                                                                                                                                                                                                                                                              toElement: Element;
                                                                                                                                                                                                                                                                                                                                              touches: undefined;
                                                                                                                                                                                                                                                                                                                                              type: string;
                                                                                                                                                                                                                                                                                                                                              view: Window;
                                                                                                                                                                                                                                                                                                                                              which: number;
                                                                                                                                                                                                                                                                                                                                              isDefaultPrevented(): boolean;
                                                                                                                                                                                                                                                                                                                                              isImmediatePropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                                              isPropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                                              preventDefault(): void;
                                                                                                                                                                                                                                                                                                                                              stopImmediatePropagation(): void;
                                                                                                                                                                                                                                                                                                                                              stopPropagation(): void;
                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                          • TDelegateTarget = any
                                                                                                                                                                                                                                                                                                                                          • TData = any
                                                                                                                                                                                                                                                                                                                                          • TCurrentTarget = any
                                                                                                                                                                                                                                                                                                                                          • TTarget = any

                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          altKey +bubbles +button +buttons +cancelable +changedTouches +char +charCode +clientX +clientY +ctrlKey +currentTarget +data +delegateTarget +detail +eventPhase +key +keyCode +metaKey +namespace? +offsetX +offsetY +originalEvent? +pageX +pageY +pointerId +pointerType +relatedTarget? +result? +screenX +screenY +shiftKey +target +targetTouches +timeStamp +toElement +touches +type +view +which +

                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                          isDefaultPrevented +isImmediatePropagationStopped +isPropagationStopped +preventDefault +stopImmediatePropagation +stopPropagation +

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          altKey: boolean
                                                                                                                                                                                                                                                                                                                                          bubbles: boolean
                                                                                                                                                                                                                                                                                                                                          button: number
                                                                                                                                                                                                                                                                                                                                          buttons: number
                                                                                                                                                                                                                                                                                                                                          cancelable: boolean
                                                                                                                                                                                                                                                                                                                                          changedTouches: undefined
                                                                                                                                                                                                                                                                                                                                          char: undefined
                                                                                                                                                                                                                                                                                                                                          charCode: undefined
                                                                                                                                                                                                                                                                                                                                          clientX: number
                                                                                                                                                                                                                                                                                                                                          clientY: number
                                                                                                                                                                                                                                                                                                                                          ctrlKey: boolean
                                                                                                                                                                                                                                                                                                                                          currentTarget: TCurrentTarget

                                                                                                                                                                                                                                                                                                                                          The current DOM element within the event bubbling phase.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.currentTarget/">https://api.jquery.com/event.currentTarget/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.3

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Alert that currentTarget matches the `this` keyword.

                                                                                                                                                                                                                                                                                                                                          $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                          alert( event.currentTarget === this ); // true
                                                                                                                                                                                                                                                                                                                                          });
+
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          data: TData

                                                                                                                                                                                                                                                                                                                                          An optional object of data passed to an event method when the current executing handler is bound.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.data/">https://api.jquery.com/event.data/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.1

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Within a for loop, pass the value of i to the .on() method so that the current iteration&#39;s value is preserved.

                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                          <title>event.data demo</title>
                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <button> 0 </button>
                                                                                                                                                                                                                                                                                                                                          <button> 1 </button>
                                                                                                                                                                                                                                                                                                                                          <button> 2 </button>
                                                                                                                                                                                                                                                                                                                                          <button> 3 </button>
                                                                                                                                                                                                                                                                                                                                          <button> 4 </button>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                          var logDiv = $( "#log" );
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          for ( var i = 0; i < 5; i++ ) {
                                                                                                                                                                                                                                                                                                                                          $( "button" ).eq( i ).on( "click", { value: i }, function( event ) {
                                                                                                                                                                                                                                                                                                                                          var msgs = [
                                                                                                                                                                                                                                                                                                                                          "button = " + $( this ).index(),
                                                                                                                                                                                                                                                                                                                                          "event.data.value = " + event.data.value,
                                                                                                                                                                                                                                                                                                                                          "i = " + i
                                                                                                                                                                                                                                                                                                                                          ];
                                                                                                                                                                                                                                                                                                                                          logDiv.append( msgs.join( ", " ) + "<br>" );
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          delegateTarget: TDelegateTarget

                                                                                                                                                                                                                                                                                                                                          The element where the currently-called jQuery event handler was attached.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.delegateTarget/">https://api.jquery.com/event.delegateTarget/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.7

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````When a button in any box class is clicked, change the box&#39;s background color to red.

                                                                                                                                                                                                                                                                                                                                          $( ".box" ).on( "click", "button", function( event ) {
                                                                                                                                                                                                                                                                                                                                          $( event.delegateTarget ).css( "background-color", "red" );
                                                                                                                                                                                                                                                                                                                                          });
+
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          detail: number
                                                                                                                                                                                                                                                                                                                                          eventPhase: number
                                                                                                                                                                                                                                                                                                                                          key: undefined
                                                                                                                                                                                                                                                                                                                                          keyCode: undefined
                                                                                                                                                                                                                                                                                                                                          metaKey: boolean

                                                                                                                                                                                                                                                                                                                                          Indicates whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.metaKey/">https://api.jquery.com/event.metaKey/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.0.4

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Determine whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                          <title>event.metaKey demo</title>
                                                                                                                                                                                                                                                                                                                                          <style>
                                                                                                                                                                                                                                                                                                                                          body {
                                                                                                                                                                                                                                                                                                                                          background-color: #eef;
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          div {
                                                                                                                                                                                                                                                                                                                                          padding: 20px;
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          </style>
                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <button value="Test" name="Test" id="checkMetaKey">Click me!</button>
                                                                                                                                                                                                                                                                                                                                          <div id="display"></div>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                          $( "#checkMetaKey" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                          $( "#display" ).text( event.metaKey );
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          namespace?: string

                                                                                                                                                                                                                                                                                                                                          The namespace specified when the event was triggered.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.namespace/">https://api.jquery.com/event.namespace/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.4.3

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Determine the event namespace used.

                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                          <title>event.namespace demo</title>
                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <button>display event.namespace</button>
                                                                                                                                                                                                                                                                                                                                          <p></p>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                          $( "p" ).on( "test.something", function( event ) {
                                                                                                                                                                                                                                                                                                                                          alert( event.namespace );
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                          $( "p" ).trigger( "test.something" );
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          offsetX: number
                                                                                                                                                                                                                                                                                                                                          offsetY: number
                                                                                                                                                                                                                                                                                                                                          originalEvent?: MouseEvent
                                                                                                                                                                                                                                                                                                                                          pageX: number

                                                                                                                                                                                                                                                                                                                                          The mouse position relative to the left edge of the document.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.pageX/">https://api.jquery.com/event.pageX/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.0.4

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe).

                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                          <title>event.pageX demo</title>
                                                                                                                                                                                                                                                                                                                                          <style>
                                                                                                                                                                                                                                                                                                                                          body {
                                                                                                                                                                                                                                                                                                                                          background-color: #eef;
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          div {
                                                                                                                                                                                                                                                                                                                                          padding: 20px;
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          </style>
                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                          $( document ).on( "mousemove", function( event ) {
                                                                                                                                                                                                                                                                                                                                          $( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          pageY: number

                                                                                                                                                                                                                                                                                                                                          The mouse position relative to the top edge of the document.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.pageY/">https://api.jquery.com/event.pageY/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.0.4

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe).

                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                          <title>event.pageY demo</title>
                                                                                                                                                                                                                                                                                                                                          <style>
                                                                                                                                                                                                                                                                                                                                          body {
                                                                                                                                                                                                                                                                                                                                          background-color: #eef;
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          div {
                                                                                                                                                                                                                                                                                                                                          padding: 20px;
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          </style>
                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                          $( document ).on( "mousemove", function( event ) {
                                                                                                                                                                                                                                                                                                                                          $( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          pointerId: undefined
                                                                                                                                                                                                                                                                                                                                          pointerType: undefined
                                                                                                                                                                                                                                                                                                                                          relatedTarget?: null | EventTarget

                                                                                                                                                                                                                                                                                                                                          The other DOM element involved in the event, if any.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.relatedTarget/">https://api.jquery.com/event.relatedTarget/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.1.4

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````On mouseout of anchors, alert the element type being entered.

                                                                                                                                                                                                                                                                                                                                          $( "a" ).mouseout(function( event ) {
                                                                                                                                                                                                                                                                                                                                          alert( event.relatedTarget.nodeName ); // "DIV"
                                                                                                                                                                                                                                                                                                                                          });
+
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          result?: any

                                                                                                                                                                                                                                                                                                                                          The last value returned by an event handler that was triggered by this event, unless the value was undefined.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.result/">https://api.jquery.com/event.result/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.3

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Display previous handler&#39;s return value

                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                          <title>event.result demo</title>
                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <button>display event.result</button>
                                                                                                                                                                                                                                                                                                                                          <p></p>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                          $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                          return "hey";
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                          $( "p" ).html( event.result );
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          screenX: number
                                                                                                                                                                                                                                                                                                                                          screenY: number
                                                                                                                                                                                                                                                                                                                                          shiftKey: boolean
                                                                                                                                                                                                                                                                                                                                          target: TTarget

                                                                                                                                                                                                                                                                                                                                          The DOM element that initiated the event.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.target/">https://api.jquery.com/event.target/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.0

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Display the tag&#39;s name on click +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>event.target demo</title> +<style> +span, strong, p { +padding: 8px; +display: block; +border: 1px solid #999; +} +</style> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<div id="log"></div> +<div> +<p> +<strong><span>click</span></strong> +</p> +</div> +​ +<script> +$( "body" ).click(function( event ) { +$( "#log" ).html( "clicked: " + event.target.nodeName ); +}); +</script> +​ +</body> +</html> +``` +@example ​ ````Implements a simple event delegation: The click handler is added to an unordered list, and the children of its li children are hidden. Clicking one of the li children toggles (see toggle()) their children.

                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                          <title>event.target demo</title>
                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <ul>
                                                                                                                                                                                                                                                                                                                                          <li>item 1
                                                                                                                                                                                                                                                                                                                                          <ul>
                                                                                                                                                                                                                                                                                                                                          <li>sub item 1-a</li>
                                                                                                                                                                                                                                                                                                                                          <li>sub item 1-b</li>
                                                                                                                                                                                                                                                                                                                                          </ul>
                                                                                                                                                                                                                                                                                                                                          </li>
                                                                                                                                                                                                                                                                                                                                          <li>item 2
                                                                                                                                                                                                                                                                                                                                          <ul>
                                                                                                                                                                                                                                                                                                                                          <li>sub item 2-a</li>
                                                                                                                                                                                                                                                                                                                                          <li>sub item 2-b</li>
                                                                                                                                                                                                                                                                                                                                          </ul>
                                                                                                                                                                                                                                                                                                                                          </li>
                                                                                                                                                                                                                                                                                                                                          </ul>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                          function handler( event ) {
                                                                                                                                                                                                                                                                                                                                          var target = $( event.target );
                                                                                                                                                                                                                                                                                                                                          if ( target.is( "li" ) ) {
                                                                                                                                                                                                                                                                                                                                          target.children().toggle();
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          $( "ul" ).click( handler ).find( "ul" ).hide();
                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          targetTouches: undefined
                                                                                                                                                                                                                                                                                                                                          timeStamp: number

                                                                                                                                                                                                                                                                                                                                          The difference in milliseconds between the time the browser created the event and January 1, 1970.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.timeStamp/">https://api.jquery.com/event.timeStamp/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.2.6

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Display the time since the click handler last executed.

                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                          <title>event.timeStamp demo</title>
                                                                                                                                                                                                                                                                                                                                          <style>
                                                                                                                                                                                                                                                                                                                                          div {
                                                                                                                                                                                                                                                                                                                                          height: 100px;
                                                                                                                                                                                                                                                                                                                                          width: 300px;
                                                                                                                                                                                                                                                                                                                                          margin: 10px;
                                                                                                                                                                                                                                                                                                                                          background-color: #ffd;
                                                                                                                                                                                                                                                                                                                                          overflow: auto;
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          </style>
                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <div>Click.</div>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                          var last, diff;
                                                                                                                                                                                                                                                                                                                                          $( "div" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                          if ( last ) {
                                                                                                                                                                                                                                                                                                                                          diff = event.timeStamp - last;
                                                                                                                                                                                                                                                                                                                                          $( "div" ).append( "time since last event: " + diff + "<br>" );
                                                                                                                                                                                                                                                                                                                                          } else {
                                                                                                                                                                                                                                                                                                                                          $( "div" ).append( "Click again.<br>" );
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          last = event.timeStamp;
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          toElement: Element
                                                                                                                                                                                                                                                                                                                                          touches: undefined
                                                                                                                                                                                                                                                                                                                                          type: string

                                                                                                                                                                                                                                                                                                                                          Describes the nature of the event.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.type/">https://api.jquery.com/event.type/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.0

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````On all anchor clicks, alert the event type.

                                                                                                                                                                                                                                                                                                                                          $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                          alert( event.type ); // "click"
                                                                                                                                                                                                                                                                                                                                          });
+
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          view: Window
                                                                                                                                                                                                                                                                                                                                          which: number

                                                                                                                                                                                                                                                                                                                                          For key or mouse events, this property indicates the specific key or button that was pressed.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.which/">https://api.jquery.com/event.which/</a>

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          1.1.3

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Log which key was depressed. +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>event.which demo</title> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<input id="whichkey" value="type something"> +<div id="log"></div> +​ +<script> +$( "#whichkey" ).on( "keydown", function( event ) { +$( "#log" ).html( event.type + ": " + event.which ); +}); +</script> +​ +</body> +</html> +``` +@example ​ ````Log which mouse button was depressed.

                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                          <title>event.which demo</title>
                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <input id="whichkey" value="click here">
                                                                                                                                                                                                                                                                                                                                          <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                          $( "#whichkey" ).on( "mousedown", function( event ) {
                                                                                                                                                                                                                                                                                                                                          $( "#log" ).html( event.type + ": " +  event.which );
                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                          • Returns whether event.preventDefault() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.isDefaultPrevented/">https://api.jquery.com/event.isDefaultPrevented/</a>

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            1.3

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Checks whether event.preventDefault() was called.

                                                                                                                                                                                                                                                                                                                                            $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                            alert( event.isDefaultPrevented() ); // false
                                                                                                                                                                                                                                                                                                                                            event.preventDefault();
                                                                                                                                                                                                                                                                                                                                            alert( event.isDefaultPrevented() ); // true
                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                          • Returns whether event.stopImmediatePropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.isImmediatePropagationStopped/">https://api.jquery.com/event.isImmediatePropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            1.3

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Checks whether event.stopImmediatePropagation() was called.

                                                                                                                                                                                                                                                                                                                                            <!doctype html>
                                                                                                                                                                                                                                                                                                                                            <html lang="en">
                                                                                                                                                                                                                                                                                                                                            <head>
                                                                                                                                                                                                                                                                                                                                            <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                            <title>event.isImmediatePropagationStopped demo</title>
                                                                                                                                                                                                                                                                                                                                            <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                            </head>
                                                                                                                                                                                                                                                                                                                                            <body>
                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                            <button>click me</button>
                                                                                                                                                                                                                                                                                                                                            <div id="stop-log"></div>
                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                            <script>
                                                                                                                                                                                                                                                                                                                                            function immediatePropStopped( event ) {
                                                                                                                                                                                                                                                                                                                                            var msg = "";
                                                                                                                                                                                                                                                                                                                                            if ( event.isImmediatePropagationStopped() ) {
                                                                                                                                                                                                                                                                                                                                            msg = "called";
                                                                                                                                                                                                                                                                                                                                            } else {
                                                                                                                                                                                                                                                                                                                                            msg = "not called";
                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                            $( "#stop-log" ).append( "<div>" + msg + "</div>" );
                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                            $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                            immediatePropStopped( event );
                                                                                                                                                                                                                                                                                                                                            event.stopImmediatePropagation();
                                                                                                                                                                                                                                                                                                                                            immediatePropStopped( event );
                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                            </script>
                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                            </body>
                                                                                                                                                                                                                                                                                                                                            </html>
+
                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                          • Returns whether event.stopPropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.isPropagationStopped/">https://api.jquery.com/event.isPropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            1.3

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Checks whether event.stopPropagation() was called

                                                                                                                                                                                                                                                                                                                                            <!doctype html>
                                                                                                                                                                                                                                                                                                                                            <html lang="en">
                                                                                                                                                                                                                                                                                                                                            <head>
                                                                                                                                                                                                                                                                                                                                            <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                            <title>event.isPropagationStopped demo</title>
                                                                                                                                                                                                                                                                                                                                            <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                            </head>
                                                                                                                                                                                                                                                                                                                                            <body>
                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                            <button>click me</button>
                                                                                                                                                                                                                                                                                                                                            <div id="stop-log"></div>
                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                            <script>
                                                                                                                                                                                                                                                                                                                                            function propStopped( event ) {
                                                                                                                                                                                                                                                                                                                                            var msg = "";
                                                                                                                                                                                                                                                                                                                                            if ( event.isPropagationStopped() ) {
                                                                                                                                                                                                                                                                                                                                            msg = "called";
                                                                                                                                                                                                                                                                                                                                            } else {
                                                                                                                                                                                                                                                                                                                                            msg = "not called";
                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                            $( "#stop-log" ).append( "<div>" + msg + "</div>" );
                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                            $( "button" ).click(function(event) {
                                                                                                                                                                                                                                                                                                                                            propStopped( event );
                                                                                                                                                                                                                                                                                                                                            event.stopPropagation();
                                                                                                                                                                                                                                                                                                                                            propStopped( event );
                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                            </script>
                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                            </body>
                                                                                                                                                                                                                                                                                                                                            </html>
+
                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                          • If this method is called, the default action of the event will not be triggered.

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.preventDefault/">https://api.jquery.com/event.preventDefault/</a>

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            1.0

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Cancel the default action (navigation) of the click.

                                                                                                                                                                                                                                                                                                                                            <!doctype html>
                                                                                                                                                                                                                                                                                                                                            <html lang="en">
                                                                                                                                                                                                                                                                                                                                            <head>
                                                                                                                                                                                                                                                                                                                                            <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                            <title>event.preventDefault demo</title>
                                                                                                                                                                                                                                                                                                                                            <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                            </head>
                                                                                                                                                                                                                                                                                                                                            <body>
                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                            <a href="https://jquery.com">default click action is prevented</a>
                                                                                                                                                                                                                                                                                                                                            <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                            <script>
                                                                                                                                                                                                                                                                                                                                            $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                            event.preventDefault();
                                                                                                                                                                                                                                                                                                                                            $( "<div>" )
                                                                                                                                                                                                                                                                                                                                            .append( "default " + event.type + " prevented" )
                                                                                                                                                                                                                                                                                                                                            .appendTo( "#log" );
                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                            </script>
                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                            </body>
                                                                                                                                                                                                                                                                                                                                            </html>
+
                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                          • Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.stopImmediatePropagation/">https://api.jquery.com/event.stopImmediatePropagation/</a>

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            1.3

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Prevents other event handlers from being called.

                                                                                                                                                                                                                                                                                                                                            <!doctype html>
                                                                                                                                                                                                                                                                                                                                            <html lang="en">
                                                                                                                                                                                                                                                                                                                                            <head>
                                                                                                                                                                                                                                                                                                                                            <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                            <title>event.stopImmediatePropagation demo</title>
                                                                                                                                                                                                                                                                                                                                            <style>
                                                                                                                                                                                                                                                                                                                                            p {
                                                                                                                                                                                                                                                                                                                                            height: 30px;
                                                                                                                                                                                                                                                                                                                                            width: 150px;
                                                                                                                                                                                                                                                                                                                                            background-color: #ccf;
                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                            div {
                                                                                                                                                                                                                                                                                                                                            height: 30px;
                                                                                                                                                                                                                                                                                                                                            width: 150px;
                                                                                                                                                                                                                                                                                                                                            background-color: #cfc;
                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                            </style>
                                                                                                                                                                                                                                                                                                                                            <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                            </head>
                                                                                                                                                                                                                                                                                                                                            <body>
                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                            <p>paragraph</p>
                                                                                                                                                                                                                                                                                                                                            <div>division</div>
                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                            <script>
                                                                                                                                                                                                                                                                                                                                            $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                            event.stopImmediatePropagation();
                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                            $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                            // This function won't be executed
                                                                                                                                                                                                                                                                                                                                            $( this ).css( "background-color", "#f00" );
                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                            $( "div" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                            // This function will be executed
                                                                                                                                                                                                                                                                                                                                            $( this ).css( "background-color", "#f00" );
                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                            </script>
                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                            </body>
                                                                                                                                                                                                                                                                                                                                            </html>
+
                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                          • Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/event.stopPropagation/">https://api.jquery.com/event.stopPropagation/</a>

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            1.0

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Kill the bubbling on the click event.

                                                                                                                                                                                                                                                                                                                                            $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                            event.stopPropagation();
                                                                                                                                                                                                                                                                                                                                            // Do something
                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NodeData.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.NodeData.html new file mode 100644 index 000000000..029598387 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.NodeData.html @@ -0,0 +1,36 @@ +NodeData | trilium
                                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                            Interface NodeData

                                                                                                                                                                                                                                                                                                                                            Data object passed to FancytreeNode() constructor. Note: typically these attributes are accessed by meber methods, e.g. node.isExpanded() and node.setSelected(false).

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            interface NodeData {
                                                                                                                                                                                                                                                                                                                                                active?: boolean;
                                                                                                                                                                                                                                                                                                                                                children?: NodeData[];
                                                                                                                                                                                                                                                                                                                                                data?: Object;
                                                                                                                                                                                                                                                                                                                                                expanded?: boolean;
                                                                                                                                                                                                                                                                                                                                                extraClasses?: string;
                                                                                                                                                                                                                                                                                                                                                focus?: boolean;
                                                                                                                                                                                                                                                                                                                                                folder?: boolean;
                                                                                                                                                                                                                                                                                                                                                hideCheckbox?: boolean;
                                                                                                                                                                                                                                                                                                                                                icon?: string | boolean;
                                                                                                                                                                                                                                                                                                                                                iconTooltip?: string;
                                                                                                                                                                                                                                                                                                                                                key?: string;
                                                                                                                                                                                                                                                                                                                                                lazy?: boolean;
                                                                                                                                                                                                                                                                                                                                                refKey?: string;
                                                                                                                                                                                                                                                                                                                                                selected?: boolean;
                                                                                                                                                                                                                                                                                                                                                statusNodeType?: string;
                                                                                                                                                                                                                                                                                                                                                title: string;
                                                                                                                                                                                                                                                                                                                                                tooltip?: string;
                                                                                                                                                                                                                                                                                                                                                type?: string;
                                                                                                                                                                                                                                                                                                                                                unselectable?: boolean;
                                                                                                                                                                                                                                                                                                                                                unselectableIgnore?: boolean;
                                                                                                                                                                                                                                                                                                                                                unselectableStatus?: boolean;
                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                            active? +children? +data? +expanded? +extraClasses? +focus? +folder? +hideCheckbox? +icon? +iconTooltip? +key? +lazy? +refKey? +selected? +statusNodeType? +title +tooltip? +type? +unselectable? +unselectableIgnore? +unselectableStatus? +

                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                            active?: boolean

                                                                                                                                                                                                                                                                                                                                            (initialization only, but will not be stored with the node).

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            children?: NodeData[]

                                                                                                                                                                                                                                                                                                                                            optional array of child nodes

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            data?: Object

                                                                                                                                                                                                                                                                                                                                            all properties from will be copied to node.data

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            expanded?: boolean
                                                                                                                                                                                                                                                                                                                                            extraClasses?: string

                                                                                                                                                                                                                                                                                                                                            class names added to the node markup (separate with space)

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            focus?: boolean

                                                                                                                                                                                                                                                                                                                                            (initialization only, but will not be stored with the node).

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            folder?: boolean
                                                                                                                                                                                                                                                                                                                                            hideCheckbox?: boolean
                                                                                                                                                                                                                                                                                                                                            icon?: string | boolean
                                                                                                                                                                                                                                                                                                                                            iconTooltip?: string

                                                                                                                                                                                                                                                                                                                                            Will be added as title attribute of the node's icon span,thus enabling a tooltip.

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            key?: string

                                                                                                                                                                                                                                                                                                                                            unique key for this node (auto-generated if omitted)

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            lazy?: boolean
                                                                                                                                                                                                                                                                                                                                            refKey?: string

                                                                                                                                                                                                                                                                                                                                            (reserved)

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            selected?: boolean
                                                                                                                                                                                                                                                                                                                                            statusNodeType?: string

                                                                                                                                                                                                                                                                                                                                            If set, make this node a status node. Values: 'error', 'loading', 'nodata', 'paging'.

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            title: string

                                                                                                                                                                                                                                                                                                                                            node text (may contain HTML tags)

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            tooltip?: string
                                                                                                                                                                                                                                                                                                                                            type?: string

                                                                                                                                                                                                                                                                                                                                            Made available as node.type.

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            unselectable?: boolean
                                                                                                                                                                                                                                                                                                                                            unselectableIgnore?: boolean

                                                                                                                                                                                                                                                                                                                                            Ignore this node when calculating the partsel status of parent nodes in selectMode 3 propagation.

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            unselectableStatus?: boolean

                                                                                                                                                                                                                                                                                                                                            Use this as constant selected value(overriding selectMode 3 propagation).

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NodePatch.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.NodePatch.html new file mode 100644 index 000000000..2eea84cf5 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.NodePatch.html @@ -0,0 +1,9 @@ +NodePatch | trilium
                                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                              Interface NodePatch

                                                                                                                                                                                                                                                                                                                                              Data object similar to NodeData, but with additional options. +May be passed to FancytreeNode#applyPatch (Every property that is omitted (or set to undefined) will be ignored)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              interface NodePatch {
                                                                                                                                                                                                                                                                                                                                                  appendChildren?: NodeData;
                                                                                                                                                                                                                                                                                                                                                  insertChildren?: NodeData;
                                                                                                                                                                                                                                                                                                                                                  replaceChildren?: NodeData;
                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              appendChildren? +insertChildren? +replaceChildren? +

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              appendChildren?: NodeData

                                                                                                                                                                                                                                                                                                                                              (not yet implemented)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              insertChildren?: NodeData

                                                                                                                                                                                                                                                                                                                                              (not yet implemented)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              replaceChildren?: NodeData

                                                                                                                                                                                                                                                                                                                                              (not yet implemented)

                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteCommandData.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteCommandData.html new file mode 100644 index 000000000..a9a1ad823 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteCommandData.html @@ -0,0 +1,6 @@ +NoteCommandData | trilium
                                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                Interface NoteCommandData

                                                                                                                                                                                                                                                                                                                                                Base interface for the data/arguments for a given command (see CommandMappings).

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                interface NoteCommandData {
                                                                                                                                                                                                                                                                                                                                                    hoistedNoteId?: null | string;
                                                                                                                                                                                                                                                                                                                                                    notePath?: null | string;
                                                                                                                                                                                                                                                                                                                                                    ntxId?: null | string;
                                                                                                                                                                                                                                                                                                                                                    viewScope?: ViewScope;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                hoistedNoteId? +notePath? +ntxId? +viewScope? +

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                hoistedNoteId?: null | string
                                                                                                                                                                                                                                                                                                                                                notePath?: null | string
                                                                                                                                                                                                                                                                                                                                                ntxId?: null | string
                                                                                                                                                                                                                                                                                                                                                viewScope?: ViewScope

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteMetaData.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteMetaData.html new file mode 100644 index 000000000..24d179c38 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteMetaData.html @@ -0,0 +1,5 @@ +NoteMetaData | trilium
                                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                  Interface NoteMetaData

                                                                                                                                                                                                                                                                                                                                                  interface NoteMetaData {
                                                                                                                                                                                                                                                                                                                                                      dateCreated: string;
                                                                                                                                                                                                                                                                                                                                                      dateModified: string;
                                                                                                                                                                                                                                                                                                                                                      utcDateCreated: string;
                                                                                                                                                                                                                                                                                                                                                      utcDateModified: string;
                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                  dateCreated +dateModified +utcDateCreated +utcDateModified +

                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                  dateCreated: string
                                                                                                                                                                                                                                                                                                                                                  dateModified: string
                                                                                                                                                                                                                                                                                                                                                  utcDateCreated: string
                                                                                                                                                                                                                                                                                                                                                  utcDateModified: string

                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NotePathRecord.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.NotePathRecord.html new file mode 100644 index 000000000..204ae9de5 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.NotePathRecord.html @@ -0,0 +1,6 @@ +NotePathRecord | trilium
                                                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                    Interface NotePathRecord

                                                                                                                                                                                                                                                                                                                                                    interface NotePathRecord {
                                                                                                                                                                                                                                                                                                                                                        isArchived: boolean;
                                                                                                                                                                                                                                                                                                                                                        isHidden: boolean;
                                                                                                                                                                                                                                                                                                                                                        isInHoistedSubTree: boolean;
                                                                                                                                                                                                                                                                                                                                                        isSearch?: boolean;
                                                                                                                                                                                                                                                                                                                                                        notePath: string[];
                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    isArchived +isHidden +isInHoistedSubTree +isSearch? +notePath +

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    isArchived: boolean
                                                                                                                                                                                                                                                                                                                                                    isHidden: boolean
                                                                                                                                                                                                                                                                                                                                                    isInHoistedSubTree: boolean
                                                                                                                                                                                                                                                                                                                                                    isSearch?: boolean
                                                                                                                                                                                                                                                                                                                                                    notePath: string[]

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteSwitchedContext.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteSwitchedContext.html new file mode 100644 index 000000000..9f0cc8d14 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.NoteSwitchedContext.html @@ -0,0 +1,3 @@ +NoteSwitchedContext | trilium
                                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                      Interface NoteSwitchedContext

                                                                                                                                                                                                                                                                                                                                                      interface NoteSwitchedContext {
                                                                                                                                                                                                                                                                                                                                                          noteContext: NoteContext;
                                                                                                                                                                                                                                                                                                                                                          notePath: undefined | null | string;
                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      noteContext +notePath +

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      noteContext: NoteContext
                                                                                                                                                                                                                                                                                                                                                      notePath: undefined | null | string

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.PersistData.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.PersistData.html new file mode 100644 index 000000000..91dbeea8f --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.PersistData.html @@ -0,0 +1,5 @@ +PersistData | trilium
                                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                        Interface PersistData

                                                                                                                                                                                                                                                                                                                                                        interface PersistData {
                                                                                                                                                                                                                                                                                                                                                            active: null | string;
                                                                                                                                                                                                                                                                                                                                                            expanded: string[];
                                                                                                                                                                                                                                                                                                                                                            focus: null | string;
                                                                                                                                                                                                                                                                                                                                                            selected: string[];
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        active +expanded +focus +selected +

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        active: null | string
                                                                                                                                                                                                                                                                                                                                                        expanded: string[]
                                                                                                                                                                                                                                                                                                                                                        focus: null | string
                                                                                                                                                                                                                                                                                                                                                        selected: string[]

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Promise.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Promise.html new file mode 100644 index 000000000..899fbf016 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Promise.html @@ -0,0 +1,443 @@ +Promise | trilium
                                                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                          Interface Promise<TR, TJ, TN>

                                                                                                                                                                                                                                                                                                                                                          This object provides a subset of the methods of the Deferred object (then, done, fail, always, pipe, progress, state and promise) to prevent users from changing the state of the Deferred.

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/Types/#Promise">https://api.jquery.com/Types/#Promise</a>

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          interface Promise<TR, TJ = any, TN = any> {
                                                                                                                                                                                                                                                                                                                                                              always(
                                                                                                                                                                                                                                                                                                                                                                  alwaysCallback: TypeOrArray<
                                                                                                                                                                                                                                                                                                                                                                      CallbackBase<TR | TJ, TR | TJ, TR | TJ, TR | TJ>,
                                                                                                                                                                                                                                                                                                                                                                  >,
                                                                                                                                                                                                                                                                                                                                                                  ...alwaysCallbacks: TypeOrArray<
                                                                                                                                                                                                                                                                                                                                                                      CallbackBase<TR | TJ, TR | TJ, TR | TJ, TR | TJ>,
                                                                                                                                                                                                                                                                                                                                                                  >[],
                                                                                                                                                                                                                                                                                                                                                              ): this;
                                                                                                                                                                                                                                                                                                                                                              catch<
                                                                                                                                                                                                                                                                                                                                                                  ARF = never,
                                                                                                                                                                                                                                                                                                                                                                  AJF = never,
                                                                                                                                                                                                                                                                                                                                                                  ANF = never,
                                                                                                                                                                                                                                                                                                                                                                  BRF = never,
                                                                                                                                                                                                                                                                                                                                                                  BJF = never,
                                                                                                                                                                                                                                                                                                                                                                  BNF = never,
                                                                                                                                                                                                                                                                                                                                                                  CRF = never,
                                                                                                                                                                                                                                                                                                                                                                  CJF = never,
                                                                                                                                                                                                                                                                                                                                                                  CNF = never,
                                                                                                                                                                                                                                                                                                                                                                  RRF = never,
                                                                                                                                                                                                                                                                                                                                                                  RJF = never,
                                                                                                                                                                                                                                                                                                                                                                  RNF = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  failFilter?:
                                                                                                                                                                                                                                                                                                                                                                      | null
                                                                                                                                                                                                                                                                                                                                                                      | (
                                                                                                                                                                                                                                                                                                                                                                          (
                                                                                                                                                                                                                                                                                                                                                                              t: TJ,
                                                                                                                                                                                                                                                                                                                                                                              u: TJ,
                                                                                                                                                                                                                                                                                                                                                                              v: TJ,
                                                                                                                                                                                                                                                                                                                                                                              ...s: TJ[],
                                                                                                                                                                                                                                                                                                                                                                          ) =>
                                                                                                                                                                                                                                                                                                                                                                              | ARF
                                                                                                                                                                                                                                                                                                                                                                              | PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                                  ARF,
                                                                                                                                                                                                                                                                                                                                                                                  AJF,
                                                                                                                                                                                                                                                                                                                                                                                  ANF,
                                                                                                                                                                                                                                                                                                                                                                                  BRF,
                                                                                                                                                                                                                                                                                                                                                                                  BJF,
                                                                                                                                                                                                                                                                                                                                                                                  BNF,
                                                                                                                                                                                                                                                                                                                                                                                  CRF,
                                                                                                                                                                                                                                                                                                                                                                                  CJF,
                                                                                                                                                                                                                                                                                                                                                                                  CNF,
                                                                                                                                                                                                                                                                                                                                                                                  RRF,
                                                                                                                                                                                                                                                                                                                                                                                  RJF,
                                                                                                                                                                                                                                                                                                                                                                                  RNF,
                                                                                                                                                                                                                                                                                                                                                                              >
                                                                                                                                                                                                                                                                                                                                                                              | Thenable<ARF>
                                                                                                                                                                                                                                                                                                                                                                      ),
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>;
                                                                                                                                                                                                                                                                                                                                                              done(
                                                                                                                                                                                                                                                                                                                                                                  doneCallback: TypeOrArray<CallbackBase<TR, TR, TR, TR>>,
                                                                                                                                                                                                                                                                                                                                                                  ...doneCallbacks: TypeOrArray<CallbackBase<TR, TR, TR, TR>>[],
                                                                                                                                                                                                                                                                                                                                                              ): this;
                                                                                                                                                                                                                                                                                                                                                              fail(
                                                                                                                                                                                                                                                                                                                                                                  failCallback: TypeOrArray<CallbackBase<TJ, TJ, TJ, TJ>>,
                                                                                                                                                                                                                                                                                                                                                                  ...failCallbacks: TypeOrArray<CallbackBase<TJ, TJ, TJ, TJ>>[],
                                                                                                                                                                                                                                                                                                                                                              ): this;
                                                                                                                                                                                                                                                                                                                                                              pipe<
                                                                                                                                                                                                                                                                                                                                                                  ARD = never,
                                                                                                                                                                                                                                                                                                                                                                  AJD = never,
                                                                                                                                                                                                                                                                                                                                                                  AND = never,
                                                                                                                                                                                                                                                                                                                                                                  BRD = never,
                                                                                                                                                                                                                                                                                                                                                                  BJD = never,
                                                                                                                                                                                                                                                                                                                                                                  BND = never,
                                                                                                                                                                                                                                                                                                                                                                  CRD = never,
                                                                                                                                                                                                                                                                                                                                                                  CJD = never,
                                                                                                                                                                                                                                                                                                                                                                  CND = never,
                                                                                                                                                                                                                                                                                                                                                                  RRD = never,
                                                                                                                                                                                                                                                                                                                                                                  RJD = never,
                                                                                                                                                                                                                                                                                                                                                                  RND = never,
                                                                                                                                                                                                                                                                                                                                                                  ARF = never,
                                                                                                                                                                                                                                                                                                                                                                  AJF = never,
                                                                                                                                                                                                                                                                                                                                                                  ANF = never,
                                                                                                                                                                                                                                                                                                                                                                  BRF = never,
                                                                                                                                                                                                                                                                                                                                                                  BJF = never,
                                                                                                                                                                                                                                                                                                                                                                  BNF = never,
                                                                                                                                                                                                                                                                                                                                                                  CRF = never,
                                                                                                                                                                                                                                                                                                                                                                  CJF = never,
                                                                                                                                                                                                                                                                                                                                                                  CNF = never,
                                                                                                                                                                                                                                                                                                                                                                  RRF = never,
                                                                                                                                                                                                                                                                                                                                                                  RJF = never,
                                                                                                                                                                                                                                                                                                                                                                  RNF = never,
                                                                                                                                                                                                                                                                                                                                                                  ARP = never,
                                                                                                                                                                                                                                                                                                                                                                  AJP = never,
                                                                                                                                                                                                                                                                                                                                                                  ANP = never,
                                                                                                                                                                                                                                                                                                                                                                  BRP = never,
                                                                                                                                                                                                                                                                                                                                                                  BJP = never,
                                                                                                                                                                                                                                                                                                                                                                  BNP = never,
                                                                                                                                                                                                                                                                                                                                                                  CRP = never,
                                                                                                                                                                                                                                                                                                                                                                  CJP = never,
                                                                                                                                                                                                                                                                                                                                                                  CNP = never,
                                                                                                                                                                                                                                                                                                                                                                  RRP = never,
                                                                                                                                                                                                                                                                                                                                                                  RJP = never,
                                                                                                                                                                                                                                                                                                                                                                  RNP = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TR,
                                                                                                                                                                                                                                                                                                                                                                      u: TR,
                                                                                                                                                                                                                                                                                                                                                                      v: TR,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TR[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ARD
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                  failFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TJ,
                                                                                                                                                                                                                                                                                                                                                                      u: TJ,
                                                                                                                                                                                                                                                                                                                                                                      v: TJ,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TJ[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | AJF
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<AJF>,
                                                                                                                                                                                                                                                                                                                                                                  progressFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TN,
                                                                                                                                                                                                                                                                                                                                                                      u: TN,
                                                                                                                                                                                                                                                                                                                                                                      v: TN,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TN[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ANP
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARD
                                                                                                                                                                                                                                                                                                                                                                  | ARF
                                                                                                                                                                                                                                                                                                                                                                  | ARP,
                                                                                                                                                                                                                                                                                                                                                                  AJD | AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                  AND | ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                  BRD | BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                  BJD | BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                  BND | BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                  CRD | CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                  CJD | CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                  CND | CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                  RRD | RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                  RJD | RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                  RND | RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                              >;
                                                                                                                                                                                                                                                                                                                                                              pipe<
                                                                                                                                                                                                                                                                                                                                                                  ARF = never,
                                                                                                                                                                                                                                                                                                                                                                  AJF = never,
                                                                                                                                                                                                                                                                                                                                                                  ANF = never,
                                                                                                                                                                                                                                                                                                                                                                  BRF = never,
                                                                                                                                                                                                                                                                                                                                                                  BJF = never,
                                                                                                                                                                                                                                                                                                                                                                  BNF = never,
                                                                                                                                                                                                                                                                                                                                                                  CRF = never,
                                                                                                                                                                                                                                                                                                                                                                  CJF = never,
                                                                                                                                                                                                                                                                                                                                                                  CNF = never,
                                                                                                                                                                                                                                                                                                                                                                  RRF = never,
                                                                                                                                                                                                                                                                                                                                                                  RJF = never,
                                                                                                                                                                                                                                                                                                                                                                  RNF = never,
                                                                                                                                                                                                                                                                                                                                                                  ARP = never,
                                                                                                                                                                                                                                                                                                                                                                  AJP = never,
                                                                                                                                                                                                                                                                                                                                                                  ANP = never,
                                                                                                                                                                                                                                                                                                                                                                  BRP = never,
                                                                                                                                                                                                                                                                                                                                                                  BJP = never,
                                                                                                                                                                                                                                                                                                                                                                  BNP = never,
                                                                                                                                                                                                                                                                                                                                                                  CRP = never,
                                                                                                                                                                                                                                                                                                                                                                  CJP = never,
                                                                                                                                                                                                                                                                                                                                                                  CNP = never,
                                                                                                                                                                                                                                                                                                                                                                  RRP = never,
                                                                                                                                                                                                                                                                                                                                                                  RJP = never,
                                                                                                                                                                                                                                                                                                                                                                  RNP = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  doneFilter: null,
                                                                                                                                                                                                                                                                                                                                                                  failFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TJ,
                                                                                                                                                                                                                                                                                                                                                                      u: TJ,
                                                                                                                                                                                                                                                                                                                                                                      v: TJ,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TJ[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | AJF
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<AJF>,
                                                                                                                                                                                                                                                                                                                                                                  progressFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TN,
                                                                                                                                                                                                                                                                                                                                                                      u: TN,
                                                                                                                                                                                                                                                                                                                                                                      v: TN,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TN[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ANP
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARF
                                                                                                                                                                                                                                                                                                                                                                  | ARP,
                                                                                                                                                                                                                                                                                                                                                                  AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                  ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                  BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                  BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                  BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                  CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                  CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                  CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                  RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                  RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                  RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                              >;
                                                                                                                                                                                                                                                                                                                                                              pipe<
                                                                                                                                                                                                                                                                                                                                                                  ARD = never,
                                                                                                                                                                                                                                                                                                                                                                  AJD = never,
                                                                                                                                                                                                                                                                                                                                                                  AND = never,
                                                                                                                                                                                                                                                                                                                                                                  BRD = never,
                                                                                                                                                                                                                                                                                                                                                                  BJD = never,
                                                                                                                                                                                                                                                                                                                                                                  BND = never,
                                                                                                                                                                                                                                                                                                                                                                  CRD = never,
                                                                                                                                                                                                                                                                                                                                                                  CJD = never,
                                                                                                                                                                                                                                                                                                                                                                  CND = never,
                                                                                                                                                                                                                                                                                                                                                                  RRD = never,
                                                                                                                                                                                                                                                                                                                                                                  RJD = never,
                                                                                                                                                                                                                                                                                                                                                                  RND = never,
                                                                                                                                                                                                                                                                                                                                                                  ARP = never,
                                                                                                                                                                                                                                                                                                                                                                  AJP = never,
                                                                                                                                                                                                                                                                                                                                                                  ANP = never,
                                                                                                                                                                                                                                                                                                                                                                  BRP = never,
                                                                                                                                                                                                                                                                                                                                                                  BJP = never,
                                                                                                                                                                                                                                                                                                                                                                  BNP = never,
                                                                                                                                                                                                                                                                                                                                                                  CRP = never,
                                                                                                                                                                                                                                                                                                                                                                  CJP = never,
                                                                                                                                                                                                                                                                                                                                                                  CNP = never,
                                                                                                                                                                                                                                                                                                                                                                  RRP = never,
                                                                                                                                                                                                                                                                                                                                                                  RJP = never,
                                                                                                                                                                                                                                                                                                                                                                  RNP = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TR,
                                                                                                                                                                                                                                                                                                                                                                      u: TR,
                                                                                                                                                                                                                                                                                                                                                                      v: TR,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TR[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ARD
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                  failFilter: null,
                                                                                                                                                                                                                                                                                                                                                                  progressFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TN,
                                                                                                                                                                                                                                                                                                                                                                      u: TN,
                                                                                                                                                                                                                                                                                                                                                                      v: TN,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TN[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ANP
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARD
                                                                                                                                                                                                                                                                                                                                                                  | ARP,
                                                                                                                                                                                                                                                                                                                                                                  AJD | AJP,
                                                                                                                                                                                                                                                                                                                                                                  AND | ANP,
                                                                                                                                                                                                                                                                                                                                                                  BRD | BRP,
                                                                                                                                                                                                                                                                                                                                                                  BJD | BJP,
                                                                                                                                                                                                                                                                                                                                                                  BND | BNP,
                                                                                                                                                                                                                                                                                                                                                                  CRD | CRP,
                                                                                                                                                                                                                                                                                                                                                                  CJD | CJP,
                                                                                                                                                                                                                                                                                                                                                                  CND | CNP,
                                                                                                                                                                                                                                                                                                                                                                  RRD | RRP,
                                                                                                                                                                                                                                                                                                                                                                  RJD | RJP,
                                                                                                                                                                                                                                                                                                                                                                  RND | RNP,
                                                                                                                                                                                                                                                                                                                                                              >;
                                                                                                                                                                                                                                                                                                                                                              pipe<
                                                                                                                                                                                                                                                                                                                                                                  ARP = never,
                                                                                                                                                                                                                                                                                                                                                                  AJP = never,
                                                                                                                                                                                                                                                                                                                                                                  ANP = never,
                                                                                                                                                                                                                                                                                                                                                                  BRP = never,
                                                                                                                                                                                                                                                                                                                                                                  BJP = never,
                                                                                                                                                                                                                                                                                                                                                                  BNP = never,
                                                                                                                                                                                                                                                                                                                                                                  CRP = never,
                                                                                                                                                                                                                                                                                                                                                                  CJP = never,
                                                                                                                                                                                                                                                                                                                                                                  CNP = never,
                                                                                                                                                                                                                                                                                                                                                                  RRP = never,
                                                                                                                                                                                                                                                                                                                                                                  RJP = never,
                                                                                                                                                                                                                                                                                                                                                                  RNP = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  doneFilter: null,
                                                                                                                                                                                                                                                                                                                                                                  failFilter: null,
                                                                                                                                                                                                                                                                                                                                                                  progressFilter?: (
                                                                                                                                                                                                                                                                                                                                                                      t: TN,
                                                                                                                                                                                                                                                                                                                                                                      u: TN,
                                                                                                                                                                                                                                                                                                                                                                      v: TN,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TN[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ANP
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>;
                                                                                                                                                                                                                                                                                                                                                              pipe<
                                                                                                                                                                                                                                                                                                                                                                  ARD = never,
                                                                                                                                                                                                                                                                                                                                                                  AJD = never,
                                                                                                                                                                                                                                                                                                                                                                  AND = never,
                                                                                                                                                                                                                                                                                                                                                                  BRD = never,
                                                                                                                                                                                                                                                                                                                                                                  BJD = never,
                                                                                                                                                                                                                                                                                                                                                                  BND = never,
                                                                                                                                                                                                                                                                                                                                                                  CRD = never,
                                                                                                                                                                                                                                                                                                                                                                  CJD = never,
                                                                                                                                                                                                                                                                                                                                                                  CND = never,
                                                                                                                                                                                                                                                                                                                                                                  RRD = never,
                                                                                                                                                                                                                                                                                                                                                                  RJD = never,
                                                                                                                                                                                                                                                                                                                                                                  RND = never,
                                                                                                                                                                                                                                                                                                                                                                  ARF = never,
                                                                                                                                                                                                                                                                                                                                                                  AJF = never,
                                                                                                                                                                                                                                                                                                                                                                  ANF = never,
                                                                                                                                                                                                                                                                                                                                                                  BRF = never,
                                                                                                                                                                                                                                                                                                                                                                  BJF = never,
                                                                                                                                                                                                                                                                                                                                                                  BNF = never,
                                                                                                                                                                                                                                                                                                                                                                  CRF = never,
                                                                                                                                                                                                                                                                                                                                                                  CJF = never,
                                                                                                                                                                                                                                                                                                                                                                  CNF = never,
                                                                                                                                                                                                                                                                                                                                                                  RRF = never,
                                                                                                                                                                                                                                                                                                                                                                  RJF = never,
                                                                                                                                                                                                                                                                                                                                                                  RNF = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TR,
                                                                                                                                                                                                                                                                                                                                                                      u: TR,
                                                                                                                                                                                                                                                                                                                                                                      v: TR,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TR[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ARD
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                  failFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TJ,
                                                                                                                                                                                                                                                                                                                                                                      u: TJ,
                                                                                                                                                                                                                                                                                                                                                                      v: TJ,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TJ[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | AJF
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<AJF>,
                                                                                                                                                                                                                                                                                                                                                                  progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARD
                                                                                                                                                                                                                                                                                                                                                                  | ARF,
                                                                                                                                                                                                                                                                                                                                                                  AJD | AJF,
                                                                                                                                                                                                                                                                                                                                                                  AND | ANF,
                                                                                                                                                                                                                                                                                                                                                                  BRD | BRF,
                                                                                                                                                                                                                                                                                                                                                                  BJD | BJF,
                                                                                                                                                                                                                                                                                                                                                                  BND | BNF,
                                                                                                                                                                                                                                                                                                                                                                  CRD | CRF,
                                                                                                                                                                                                                                                                                                                                                                  CJD | CJF,
                                                                                                                                                                                                                                                                                                                                                                  CND | CNF,
                                                                                                                                                                                                                                                                                                                                                                  RRD | RRF,
                                                                                                                                                                                                                                                                                                                                                                  RJD | RJF,
                                                                                                                                                                                                                                                                                                                                                                  RND | RNF,
                                                                                                                                                                                                                                                                                                                                                              >;
                                                                                                                                                                                                                                                                                                                                                              pipe<
                                                                                                                                                                                                                                                                                                                                                                  ARF = never,
                                                                                                                                                                                                                                                                                                                                                                  AJF = never,
                                                                                                                                                                                                                                                                                                                                                                  ANF = never,
                                                                                                                                                                                                                                                                                                                                                                  BRF = never,
                                                                                                                                                                                                                                                                                                                                                                  BJF = never,
                                                                                                                                                                                                                                                                                                                                                                  BNF = never,
                                                                                                                                                                                                                                                                                                                                                                  CRF = never,
                                                                                                                                                                                                                                                                                                                                                                  CJF = never,
                                                                                                                                                                                                                                                                                                                                                                  CNF = never,
                                                                                                                                                                                                                                                                                                                                                                  RRF = never,
                                                                                                                                                                                                                                                                                                                                                                  RJF = never,
                                                                                                                                                                                                                                                                                                                                                                  RNF = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  doneFilter: null,
                                                                                                                                                                                                                                                                                                                                                                  failFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TJ,
                                                                                                                                                                                                                                                                                                                                                                      u: TJ,
                                                                                                                                                                                                                                                                                                                                                                      v: TJ,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TJ[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | AJF
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<AJF>,
                                                                                                                                                                                                                                                                                                                                                                  progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>;
                                                                                                                                                                                                                                                                                                                                                              pipe<
                                                                                                                                                                                                                                                                                                                                                                  ARD = never,
                                                                                                                                                                                                                                                                                                                                                                  AJD = never,
                                                                                                                                                                                                                                                                                                                                                                  AND = never,
                                                                                                                                                                                                                                                                                                                                                                  BRD = never,
                                                                                                                                                                                                                                                                                                                                                                  BJD = never,
                                                                                                                                                                                                                                                                                                                                                                  BND = never,
                                                                                                                                                                                                                                                                                                                                                                  CRD = never,
                                                                                                                                                                                                                                                                                                                                                                  CJD = never,
                                                                                                                                                                                                                                                                                                                                                                  CND = never,
                                                                                                                                                                                                                                                                                                                                                                  RRD = never,
                                                                                                                                                                                                                                                                                                                                                                  RJD = never,
                                                                                                                                                                                                                                                                                                                                                                  RND = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TR,
                                                                                                                                                                                                                                                                                                                                                                      u: TR,
                                                                                                                                                                                                                                                                                                                                                                      v: TR,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TR[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ARD
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                  failFilter?: null,
                                                                                                                                                                                                                                                                                                                                                                  progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>;
                                                                                                                                                                                                                                                                                                                                                              progress(
                                                                                                                                                                                                                                                                                                                                                                  progressCallback: TypeOrArray<CallbackBase<TN, TN, TN, TN>>,
                                                                                                                                                                                                                                                                                                                                                                  ...progressCallbacks: TypeOrArray<CallbackBase<TN, TN, TN, TN>>[],
                                                                                                                                                                                                                                                                                                                                                              ): this;
                                                                                                                                                                                                                                                                                                                                                              promise<TTarget extends object>(
                                                                                                                                                                                                                                                                                                                                                                  target: TTarget,
                                                                                                                                                                                                                                                                                                                                                              ): Promise<TR, TJ, TN> & TTarget;
                                                                                                                                                                                                                                                                                                                                                              promise(): this;
                                                                                                                                                                                                                                                                                                                                                              state(): "pending" | "resolved" | "rejected";
                                                                                                                                                                                                                                                                                                                                                              then<
                                                                                                                                                                                                                                                                                                                                                                  ARD = never,
                                                                                                                                                                                                                                                                                                                                                                  AJD = never,
                                                                                                                                                                                                                                                                                                                                                                  AND = never,
                                                                                                                                                                                                                                                                                                                                                                  BRD = never,
                                                                                                                                                                                                                                                                                                                                                                  BJD = never,
                                                                                                                                                                                                                                                                                                                                                                  BND = never,
                                                                                                                                                                                                                                                                                                                                                                  CRD = never,
                                                                                                                                                                                                                                                                                                                                                                  CJD = never,
                                                                                                                                                                                                                                                                                                                                                                  CND = never,
                                                                                                                                                                                                                                                                                                                                                                  RRD = never,
                                                                                                                                                                                                                                                                                                                                                                  RJD = never,
                                                                                                                                                                                                                                                                                                                                                                  RND = never,
                                                                                                                                                                                                                                                                                                                                                                  ARF = never,
                                                                                                                                                                                                                                                                                                                                                                  AJF = never,
                                                                                                                                                                                                                                                                                                                                                                  ANF = never,
                                                                                                                                                                                                                                                                                                                                                                  BRF = never,
                                                                                                                                                                                                                                                                                                                                                                  BJF = never,
                                                                                                                                                                                                                                                                                                                                                                  BNF = never,
                                                                                                                                                                                                                                                                                                                                                                  CRF = never,
                                                                                                                                                                                                                                                                                                                                                                  CJF = never,
                                                                                                                                                                                                                                                                                                                                                                  CNF = never,
                                                                                                                                                                                                                                                                                                                                                                  RRF = never,
                                                                                                                                                                                                                                                                                                                                                                  RJF = never,
                                                                                                                                                                                                                                                                                                                                                                  RNF = never,
                                                                                                                                                                                                                                                                                                                                                                  ARP = never,
                                                                                                                                                                                                                                                                                                                                                                  AJP = never,
                                                                                                                                                                                                                                                                                                                                                                  ANP = never,
                                                                                                                                                                                                                                                                                                                                                                  BRP = never,
                                                                                                                                                                                                                                                                                                                                                                  BJP = never,
                                                                                                                                                                                                                                                                                                                                                                  BNP = never,
                                                                                                                                                                                                                                                                                                                                                                  CRP = never,
                                                                                                                                                                                                                                                                                                                                                                  CJP = never,
                                                                                                                                                                                                                                                                                                                                                                  CNP = never,
                                                                                                                                                                                                                                                                                                                                                                  RRP = never,
                                                                                                                                                                                                                                                                                                                                                                  RJP = never,
                                                                                                                                                                                                                                                                                                                                                                  RNP = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TR,
                                                                                                                                                                                                                                                                                                                                                                      u: TR,
                                                                                                                                                                                                                                                                                                                                                                      v: TR,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TR[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ARD
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                  failFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TJ,
                                                                                                                                                                                                                                                                                                                                                                      u: TJ,
                                                                                                                                                                                                                                                                                                                                                                      v: TJ,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TJ[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ARF
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ARF>,
                                                                                                                                                                                                                                                                                                                                                                  progressFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TN,
                                                                                                                                                                                                                                                                                                                                                                      u: TN,
                                                                                                                                                                                                                                                                                                                                                                      v: TN,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TN[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ANP
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARD
                                                                                                                                                                                                                                                                                                                                                                  | ARF
                                                                                                                                                                                                                                                                                                                                                                  | ARP,
                                                                                                                                                                                                                                                                                                                                                                  AJD | AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                  AND | ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                  BRD | BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                  BJD | BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                  BND | BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                  CRD | CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                  CJD | CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                  CND | CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                  RRD | RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                  RJD | RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                  RND | RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                              >;
                                                                                                                                                                                                                                                                                                                                                              then<
                                                                                                                                                                                                                                                                                                                                                                  ARF = never,
                                                                                                                                                                                                                                                                                                                                                                  AJF = never,
                                                                                                                                                                                                                                                                                                                                                                  ANF = never,
                                                                                                                                                                                                                                                                                                                                                                  BRF = never,
                                                                                                                                                                                                                                                                                                                                                                  BJF = never,
                                                                                                                                                                                                                                                                                                                                                                  BNF = never,
                                                                                                                                                                                                                                                                                                                                                                  CRF = never,
                                                                                                                                                                                                                                                                                                                                                                  CJF = never,
                                                                                                                                                                                                                                                                                                                                                                  CNF = never,
                                                                                                                                                                                                                                                                                                                                                                  RRF = never,
                                                                                                                                                                                                                                                                                                                                                                  RJF = never,
                                                                                                                                                                                                                                                                                                                                                                  RNF = never,
                                                                                                                                                                                                                                                                                                                                                                  ARP = never,
                                                                                                                                                                                                                                                                                                                                                                  AJP = never,
                                                                                                                                                                                                                                                                                                                                                                  ANP = never,
                                                                                                                                                                                                                                                                                                                                                                  BRP = never,
                                                                                                                                                                                                                                                                                                                                                                  BJP = never,
                                                                                                                                                                                                                                                                                                                                                                  BNP = never,
                                                                                                                                                                                                                                                                                                                                                                  CRP = never,
                                                                                                                                                                                                                                                                                                                                                                  CJP = never,
                                                                                                                                                                                                                                                                                                                                                                  CNP = never,
                                                                                                                                                                                                                                                                                                                                                                  RRP = never,
                                                                                                                                                                                                                                                                                                                                                                  RJP = never,
                                                                                                                                                                                                                                                                                                                                                                  RNP = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  doneFilter: null,
                                                                                                                                                                                                                                                                                                                                                                  failFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TJ,
                                                                                                                                                                                                                                                                                                                                                                      u: TJ,
                                                                                                                                                                                                                                                                                                                                                                      v: TJ,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TJ[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ARF
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ARF>,
                                                                                                                                                                                                                                                                                                                                                                  progressFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TN,
                                                                                                                                                                                                                                                                                                                                                                      u: TN,
                                                                                                                                                                                                                                                                                                                                                                      v: TN,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TN[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ANP
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARF
                                                                                                                                                                                                                                                                                                                                                                  | ARP,
                                                                                                                                                                                                                                                                                                                                                                  AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                  ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                  BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                  BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                  BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                  CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                  CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                  CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                  RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                  RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                  RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                              >;
                                                                                                                                                                                                                                                                                                                                                              then<
                                                                                                                                                                                                                                                                                                                                                                  ARD = never,
                                                                                                                                                                                                                                                                                                                                                                  AJD = never,
                                                                                                                                                                                                                                                                                                                                                                  AND = never,
                                                                                                                                                                                                                                                                                                                                                                  BRD = never,
                                                                                                                                                                                                                                                                                                                                                                  BJD = never,
                                                                                                                                                                                                                                                                                                                                                                  BND = never,
                                                                                                                                                                                                                                                                                                                                                                  CRD = never,
                                                                                                                                                                                                                                                                                                                                                                  CJD = never,
                                                                                                                                                                                                                                                                                                                                                                  CND = never,
                                                                                                                                                                                                                                                                                                                                                                  RRD = never,
                                                                                                                                                                                                                                                                                                                                                                  RJD = never,
                                                                                                                                                                                                                                                                                                                                                                  RND = never,
                                                                                                                                                                                                                                                                                                                                                                  ARP = never,
                                                                                                                                                                                                                                                                                                                                                                  AJP = never,
                                                                                                                                                                                                                                                                                                                                                                  ANP = never,
                                                                                                                                                                                                                                                                                                                                                                  BRP = never,
                                                                                                                                                                                                                                                                                                                                                                  BJP = never,
                                                                                                                                                                                                                                                                                                                                                                  BNP = never,
                                                                                                                                                                                                                                                                                                                                                                  CRP = never,
                                                                                                                                                                                                                                                                                                                                                                  CJP = never,
                                                                                                                                                                                                                                                                                                                                                                  CNP = never,
                                                                                                                                                                                                                                                                                                                                                                  RRP = never,
                                                                                                                                                                                                                                                                                                                                                                  RJP = never,
                                                                                                                                                                                                                                                                                                                                                                  RNP = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TR,
                                                                                                                                                                                                                                                                                                                                                                      u: TR,
                                                                                                                                                                                                                                                                                                                                                                      v: TR,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TR[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ARD
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                  failFilter: null,
                                                                                                                                                                                                                                                                                                                                                                  progressFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TN,
                                                                                                                                                                                                                                                                                                                                                                      u: TN,
                                                                                                                                                                                                                                                                                                                                                                      v: TN,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TN[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ANP
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARD
                                                                                                                                                                                                                                                                                                                                                                  | ARP,
                                                                                                                                                                                                                                                                                                                                                                  AJD | AJP,
                                                                                                                                                                                                                                                                                                                                                                  AND | ANP,
                                                                                                                                                                                                                                                                                                                                                                  BRD | BRP,
                                                                                                                                                                                                                                                                                                                                                                  BJD | BJP,
                                                                                                                                                                                                                                                                                                                                                                  BND | BNP,
                                                                                                                                                                                                                                                                                                                                                                  CRD | CRP,
                                                                                                                                                                                                                                                                                                                                                                  CJD | CJP,
                                                                                                                                                                                                                                                                                                                                                                  CND | CNP,
                                                                                                                                                                                                                                                                                                                                                                  RRD | RRP,
                                                                                                                                                                                                                                                                                                                                                                  RJD | RJP,
                                                                                                                                                                                                                                                                                                                                                                  RND | RNP,
                                                                                                                                                                                                                                                                                                                                                              >;
                                                                                                                                                                                                                                                                                                                                                              then<
                                                                                                                                                                                                                                                                                                                                                                  ARP = never,
                                                                                                                                                                                                                                                                                                                                                                  AJP = never,
                                                                                                                                                                                                                                                                                                                                                                  ANP = never,
                                                                                                                                                                                                                                                                                                                                                                  BRP = never,
                                                                                                                                                                                                                                                                                                                                                                  BJP = never,
                                                                                                                                                                                                                                                                                                                                                                  BNP = never,
                                                                                                                                                                                                                                                                                                                                                                  CRP = never,
                                                                                                                                                                                                                                                                                                                                                                  CJP = never,
                                                                                                                                                                                                                                                                                                                                                                  CNP = never,
                                                                                                                                                                                                                                                                                                                                                                  RRP = never,
                                                                                                                                                                                                                                                                                                                                                                  RJP = never,
                                                                                                                                                                                                                                                                                                                                                                  RNP = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  doneFilter: null,
                                                                                                                                                                                                                                                                                                                                                                  failFilter: null,
                                                                                                                                                                                                                                                                                                                                                                  progressFilter?: (
                                                                                                                                                                                                                                                                                                                                                                      t: TN,
                                                                                                                                                                                                                                                                                                                                                                      u: TN,
                                                                                                                                                                                                                                                                                                                                                                      v: TN,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TN[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ANP
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>;
                                                                                                                                                                                                                                                                                                                                                              then<
                                                                                                                                                                                                                                                                                                                                                                  ARD = never,
                                                                                                                                                                                                                                                                                                                                                                  AJD = never,
                                                                                                                                                                                                                                                                                                                                                                  AND = never,
                                                                                                                                                                                                                                                                                                                                                                  BRD = never,
                                                                                                                                                                                                                                                                                                                                                                  BJD = never,
                                                                                                                                                                                                                                                                                                                                                                  BND = never,
                                                                                                                                                                                                                                                                                                                                                                  CRD = never,
                                                                                                                                                                                                                                                                                                                                                                  CJD = never,
                                                                                                                                                                                                                                                                                                                                                                  CND = never,
                                                                                                                                                                                                                                                                                                                                                                  RRD = never,
                                                                                                                                                                                                                                                                                                                                                                  RJD = never,
                                                                                                                                                                                                                                                                                                                                                                  RND = never,
                                                                                                                                                                                                                                                                                                                                                                  ARF = never,
                                                                                                                                                                                                                                                                                                                                                                  AJF = never,
                                                                                                                                                                                                                                                                                                                                                                  ANF = never,
                                                                                                                                                                                                                                                                                                                                                                  BRF = never,
                                                                                                                                                                                                                                                                                                                                                                  BJF = never,
                                                                                                                                                                                                                                                                                                                                                                  BNF = never,
                                                                                                                                                                                                                                                                                                                                                                  CRF = never,
                                                                                                                                                                                                                                                                                                                                                                  CJF = never,
                                                                                                                                                                                                                                                                                                                                                                  CNF = never,
                                                                                                                                                                                                                                                                                                                                                                  RRF = never,
                                                                                                                                                                                                                                                                                                                                                                  RJF = never,
                                                                                                                                                                                                                                                                                                                                                                  RNF = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TR,
                                                                                                                                                                                                                                                                                                                                                                      u: TR,
                                                                                                                                                                                                                                                                                                                                                                      v: TR,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TR[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ARD
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                  failFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TJ,
                                                                                                                                                                                                                                                                                                                                                                      u: TJ,
                                                                                                                                                                                                                                                                                                                                                                      v: TJ,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TJ[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ARF
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ARF>,
                                                                                                                                                                                                                                                                                                                                                                  progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARD
                                                                                                                                                                                                                                                                                                                                                                  | ARF,
                                                                                                                                                                                                                                                                                                                                                                  AJD | AJF,
                                                                                                                                                                                                                                                                                                                                                                  AND | ANF,
                                                                                                                                                                                                                                                                                                                                                                  BRD | BRF,
                                                                                                                                                                                                                                                                                                                                                                  BJD | BJF,
                                                                                                                                                                                                                                                                                                                                                                  BND | BNF,
                                                                                                                                                                                                                                                                                                                                                                  CRD | CRF,
                                                                                                                                                                                                                                                                                                                                                                  CJD | CJF,
                                                                                                                                                                                                                                                                                                                                                                  CND | CNF,
                                                                                                                                                                                                                                                                                                                                                                  RRD | RRF,
                                                                                                                                                                                                                                                                                                                                                                  RJD | RJF,
                                                                                                                                                                                                                                                                                                                                                                  RND | RNF,
                                                                                                                                                                                                                                                                                                                                                              >;
                                                                                                                                                                                                                                                                                                                                                              then<
                                                                                                                                                                                                                                                                                                                                                                  ARF = never,
                                                                                                                                                                                                                                                                                                                                                                  AJF = never,
                                                                                                                                                                                                                                                                                                                                                                  ANF = never,
                                                                                                                                                                                                                                                                                                                                                                  BRF = never,
                                                                                                                                                                                                                                                                                                                                                                  BJF = never,
                                                                                                                                                                                                                                                                                                                                                                  BNF = never,
                                                                                                                                                                                                                                                                                                                                                                  CRF = never,
                                                                                                                                                                                                                                                                                                                                                                  CJF = never,
                                                                                                                                                                                                                                                                                                                                                                  CNF = never,
                                                                                                                                                                                                                                                                                                                                                                  RRF = never,
                                                                                                                                                                                                                                                                                                                                                                  RJF = never,
                                                                                                                                                                                                                                                                                                                                                                  RNF = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  doneFilter: null,
                                                                                                                                                                                                                                                                                                                                                                  failFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TJ,
                                                                                                                                                                                                                                                                                                                                                                      u: TJ,
                                                                                                                                                                                                                                                                                                                                                                      v: TJ,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TJ[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ARF
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ARF>,
                                                                                                                                                                                                                                                                                                                                                                  progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>;
                                                                                                                                                                                                                                                                                                                                                              then<
                                                                                                                                                                                                                                                                                                                                                                  ARD = never,
                                                                                                                                                                                                                                                                                                                                                                  AJD = never,
                                                                                                                                                                                                                                                                                                                                                                  AND = never,
                                                                                                                                                                                                                                                                                                                                                                  BRD = never,
                                                                                                                                                                                                                                                                                                                                                                  BJD = never,
                                                                                                                                                                                                                                                                                                                                                                  BND = never,
                                                                                                                                                                                                                                                                                                                                                                  CRD = never,
                                                                                                                                                                                                                                                                                                                                                                  CJD = never,
                                                                                                                                                                                                                                                                                                                                                                  CND = never,
                                                                                                                                                                                                                                                                                                                                                                  RRD = never,
                                                                                                                                                                                                                                                                                                                                                                  RJD = never,
                                                                                                                                                                                                                                                                                                                                                                  RND = never,
                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                  doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                      t: TR,
                                                                                                                                                                                                                                                                                                                                                                      u: TR,
                                                                                                                                                                                                                                                                                                                                                                      v: TR,
                                                                                                                                                                                                                                                                                                                                                                      ...s: TR[],
                                                                                                                                                                                                                                                                                                                                                                  ) =>
                                                                                                                                                                                                                                                                                                                                                                      | ARD
                                                                                                                                                                                                                                                                                                                                                                      | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                      | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                  failFilter?: null,
                                                                                                                                                                                                                                                                                                                                                                  progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                                              ): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>;
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                          • TR
                                                                                                                                                                                                                                                                                                                                                          • TJ = any
                                                                                                                                                                                                                                                                                                                                                          • TN = any

                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                          always +catch +done +fail +pipe +progress +promise +state +then +

                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                          • Add handlers to be called when the Deferred object is either resolved or rejected.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.always/">https://api.jquery.com/deferred.always/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.6

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Since the jQuery.get() method returns a jqXHR object, which is derived from a Deferred object, we can attach a callback for both success and error using the deferred.always() method.

                                                                                                                                                                                                                                                                                                                                                            $.get( "test.php" ).always(function() {
                                                                                                                                                                                                                                                                                                                                                            alert( "$.get completed with success or error callback arguments" );
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Add handlers to be called when the Deferred object is rejected.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARF = never
                                                                                                                                                                                                                                                                                                                                                            • AJF = never
                                                                                                                                                                                                                                                                                                                                                            • ANF = never
                                                                                                                                                                                                                                                                                                                                                            • BRF = never
                                                                                                                                                                                                                                                                                                                                                            • BJF = never
                                                                                                                                                                                                                                                                                                                                                            • BNF = never
                                                                                                                                                                                                                                                                                                                                                            • CRF = never
                                                                                                                                                                                                                                                                                                                                                            • CJF = never
                                                                                                                                                                                                                                                                                                                                                            • CNF = never
                                                                                                                                                                                                                                                                                                                                                            • RRF = never
                                                                                                                                                                                                                                                                                                                                                            • RJF = never
                                                                                                                                                                                                                                                                                                                                                            • RNF = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            • OptionalfailFilter:
                                                                                                                                                                                                                                                                                                                                                                  | null
                                                                                                                                                                                                                                                                                                                                                                  | (
                                                                                                                                                                                                                                                                                                                                                                      (
                                                                                                                                                                                                                                                                                                                                                                          t: TJ,
                                                                                                                                                                                                                                                                                                                                                                          u: TJ,
                                                                                                                                                                                                                                                                                                                                                                          v: TJ,
                                                                                                                                                                                                                                                                                                                                                                          ...s: TJ[],
                                                                                                                                                                                                                                                                                                                                                                      ) =>
                                                                                                                                                                                                                                                                                                                                                                          | ARF
                                                                                                                                                                                                                                                                                                                                                                          | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                          | Thenable<ARF>
                                                                                                                                                                                                                                                                                                                                                                  )

                                                                                                                                                                                                                                                                                                                                                              A function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.catch/">https://api.jquery.com/deferred.catch/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            3.0

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can rejection handlers using the .catch method.

                                                                                                                                                                                                                                                                                                                                                            $.get( "test.php" )
                                                                                                                                                                                                                                                                                                                                                            .then( function() {
                                                                                                                                                                                                                                                                                                                                                            alert( "$.get succeeded" );
                                                                                                                                                                                                                                                                                                                                                            } )
                                                                                                                                                                                                                                                                                                                                                            .catch( function() {
                                                                                                                                                                                                                                                                                                                                                            alert( "$.get failed!" );
                                                                                                                                                                                                                                                                                                                                                            } );
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Add handlers to be called when the Deferred object is resolved.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.done/">https://api.jquery.com/deferred.done/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.5

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach a success callback using the .done() method. +```javascript +$.get( "test.php" ).done(function() { +alert( "$.get succeeded" ); +}); +``` +@example ​ ````Resolve a Deferred object when the user clicks a button, triggering a number of callback functions:

                                                                                                                                                                                                                                                                                                                                                            <!doctype html>
                                                                                                                                                                                                                                                                                                                                                            <html lang="en">
                                                                                                                                                                                                                                                                                                                                                            <head>
                                                                                                                                                                                                                                                                                                                                                            <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                            <title>deferred.done demo</title>
                                                                                                                                                                                                                                                                                                                                                            <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                            </head>
                                                                                                                                                                                                                                                                                                                                                            <body>
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            <button>Go</button>
                                                                                                                                                                                                                                                                                                                                                            <p>Ready...</p>
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            <script>
                                                                                                                                                                                                                                                                                                                                                            // 3 functions to call when the Deferred object is resolved
                                                                                                                                                                                                                                                                                                                                                            function fn1() {
                                                                                                                                                                                                                                                                                                                                                            $( "p" ).append( " 1 " );
                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                            function fn2() {
                                                                                                                                                                                                                                                                                                                                                            $( "p" ).append( " 2 " );
                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                            function fn3( n ) {
                                                                                                                                                                                                                                                                                                                                                            $( "p" ).append( n + " 3 " + n );
                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            // Create a deferred object
                                                                                                                                                                                                                                                                                                                                                            var dfd = $.Deferred();
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            // Add handlers to be called when dfd is resolved
                                                                                                                                                                                                                                                                                                                                                            dfd
                                                                                                                                                                                                                                                                                                                                                            // .done() can take any number of functions or arrays of functions
                                                                                                                                                                                                                                                                                                                                                            .done( [ fn1, fn2 ], fn3, [ fn2, fn1 ] )
                                                                                                                                                                                                                                                                                                                                                            // We can chain done methods, too
                                                                                                                                                                                                                                                                                                                                                            .done(function( n ) {
                                                                                                                                                                                                                                                                                                                                                            $( "p" ).append( n + " we're done." );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            // Resolve the Deferred object when the button is clicked
                                                                                                                                                                                                                                                                                                                                                            $( "button" ).on( "click", function() {
                                                                                                                                                                                                                                                                                                                                                            dfd.resolve( "and" );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            </script>
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            </body>
                                                                                                                                                                                                                                                                                                                                                            </html>
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Add handlers to be called when the Deferred object is rejected.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.fail/">https://api.jquery.com/deferred.fail/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.5

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred, you can attach a success and failure callback using the deferred.done() and deferred.fail() methods.

                                                                                                                                                                                                                                                                                                                                                            $.get( "test.php" )
                                                                                                                                                                                                                                                                                                                                                            .done(function() {
                                                                                                                                                                                                                                                                                                                                                            alert( "$.get succeeded" );
                                                                                                                                                                                                                                                                                                                                                            })
                                                                                                                                                                                                                                                                                                                                                            .fail(function() {
                                                                                                                                                                                                                                                                                                                                                            alert( "$.get failed!" );
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARD = never
                                                                                                                                                                                                                                                                                                                                                            • AJD = never
                                                                                                                                                                                                                                                                                                                                                            • AND = never
                                                                                                                                                                                                                                                                                                                                                            • BRD = never
                                                                                                                                                                                                                                                                                                                                                            • BJD = never
                                                                                                                                                                                                                                                                                                                                                            • BND = never
                                                                                                                                                                                                                                                                                                                                                            • CRD = never
                                                                                                                                                                                                                                                                                                                                                            • CJD = never
                                                                                                                                                                                                                                                                                                                                                            • CND = never
                                                                                                                                                                                                                                                                                                                                                            • RRD = never
                                                                                                                                                                                                                                                                                                                                                            • RJD = never
                                                                                                                                                                                                                                                                                                                                                            • RND = never
                                                                                                                                                                                                                                                                                                                                                            • ARF = never
                                                                                                                                                                                                                                                                                                                                                            • AJF = never
                                                                                                                                                                                                                                                                                                                                                            • ANF = never
                                                                                                                                                                                                                                                                                                                                                            • BRF = never
                                                                                                                                                                                                                                                                                                                                                            • BJF = never
                                                                                                                                                                                                                                                                                                                                                            • BNF = never
                                                                                                                                                                                                                                                                                                                                                            • CRF = never
                                                                                                                                                                                                                                                                                                                                                            • CJF = never
                                                                                                                                                                                                                                                                                                                                                            • CNF = never
                                                                                                                                                                                                                                                                                                                                                            • RRF = never
                                                                                                                                                                                                                                                                                                                                                            • RJF = never
                                                                                                                                                                                                                                                                                                                                                            • RNF = never
                                                                                                                                                                                                                                                                                                                                                            • ARP = never
                                                                                                                                                                                                                                                                                                                                                            • AJP = never
                                                                                                                                                                                                                                                                                                                                                            • ANP = never
                                                                                                                                                                                                                                                                                                                                                            • BRP = never
                                                                                                                                                                                                                                                                                                                                                            • BJP = never
                                                                                                                                                                                                                                                                                                                                                            • BNP = never
                                                                                                                                                                                                                                                                                                                                                            • CRP = never
                                                                                                                                                                                                                                                                                                                                                            • CJP = never
                                                                                                                                                                                                                                                                                                                                                            • CNP = never
                                                                                                                                                                                                                                                                                                                                                            • RRP = never
                                                                                                                                                                                                                                                                                                                                                            • RJP = never
                                                                                                                                                                                                                                                                                                                                                            • RNP = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                ARD
                                                                                                                                                                                                                                                                                                                                                                | ARF
                                                                                                                                                                                                                                                                                                                                                                | ARP,
                                                                                                                                                                                                                                                                                                                                                                AJD | AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                AND | ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                BRD | BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                BJD | BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                BND | BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                CRD | CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                CJD | CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                CND | CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                RRD | RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                RJD | RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                RND | RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                            >

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.6

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.7

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Filter resolve value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +alert( "Value is ( 2*5 = ) 10: " + value ); +}); +``` +@example ​ ````Filter reject value:

                                                                                                                                                                                                                                                                                                                                                            var defer = $.Deferred(),
                                                                                                                                                                                                                                                                                                                                                            filtered = defer.pipe( null, function( value ) {
                                                                                                                                                                                                                                                                                                                                                            return value * 3;
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            defer.reject( 6 );
                                                                                                                                                                                                                                                                                                                                                            filtered.fail(function( value ) {
                                                                                                                                                                                                                                                                                                                                                            alert( "Value is ( 3*6 = ) 18: " + value );
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                            var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                            chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARF = never
                                                                                                                                                                                                                                                                                                                                                            • AJF = never
                                                                                                                                                                                                                                                                                                                                                            • ANF = never
                                                                                                                                                                                                                                                                                                                                                            • BRF = never
                                                                                                                                                                                                                                                                                                                                                            • BJF = never
                                                                                                                                                                                                                                                                                                                                                            • BNF = never
                                                                                                                                                                                                                                                                                                                                                            • CRF = never
                                                                                                                                                                                                                                                                                                                                                            • CJF = never
                                                                                                                                                                                                                                                                                                                                                            • CNF = never
                                                                                                                                                                                                                                                                                                                                                            • RRF = never
                                                                                                                                                                                                                                                                                                                                                            • RJF = never
                                                                                                                                                                                                                                                                                                                                                            • RNF = never
                                                                                                                                                                                                                                                                                                                                                            • ARP = never
                                                                                                                                                                                                                                                                                                                                                            • AJP = never
                                                                                                                                                                                                                                                                                                                                                            • ANP = never
                                                                                                                                                                                                                                                                                                                                                            • BRP = never
                                                                                                                                                                                                                                                                                                                                                            • BJP = never
                                                                                                                                                                                                                                                                                                                                                            • BNP = never
                                                                                                                                                                                                                                                                                                                                                            • CRP = never
                                                                                                                                                                                                                                                                                                                                                            • CJP = never
                                                                                                                                                                                                                                                                                                                                                            • CNP = never
                                                                                                                                                                                                                                                                                                                                                            • RRP = never
                                                                                                                                                                                                                                                                                                                                                            • RJP = never
                                                                                                                                                                                                                                                                                                                                                            • RNP = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                ARF
                                                                                                                                                                                                                                                                                                                                                                | ARP,
                                                                                                                                                                                                                                                                                                                                                                AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                            >

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.6

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.7

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                            var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                            chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARD = never
                                                                                                                                                                                                                                                                                                                                                            • AJD = never
                                                                                                                                                                                                                                                                                                                                                            • AND = never
                                                                                                                                                                                                                                                                                                                                                            • BRD = never
                                                                                                                                                                                                                                                                                                                                                            • BJD = never
                                                                                                                                                                                                                                                                                                                                                            • BND = never
                                                                                                                                                                                                                                                                                                                                                            • CRD = never
                                                                                                                                                                                                                                                                                                                                                            • CJD = never
                                                                                                                                                                                                                                                                                                                                                            • CND = never
                                                                                                                                                                                                                                                                                                                                                            • RRD = never
                                                                                                                                                                                                                                                                                                                                                            • RJD = never
                                                                                                                                                                                                                                                                                                                                                            • RND = never
                                                                                                                                                                                                                                                                                                                                                            • ARP = never
                                                                                                                                                                                                                                                                                                                                                            • AJP = never
                                                                                                                                                                                                                                                                                                                                                            • ANP = never
                                                                                                                                                                                                                                                                                                                                                            • BRP = never
                                                                                                                                                                                                                                                                                                                                                            • BJP = never
                                                                                                                                                                                                                                                                                                                                                            • BNP = never
                                                                                                                                                                                                                                                                                                                                                            • CRP = never
                                                                                                                                                                                                                                                                                                                                                            • CJP = never
                                                                                                                                                                                                                                                                                                                                                            • CNP = never
                                                                                                                                                                                                                                                                                                                                                            • RRP = never
                                                                                                                                                                                                                                                                                                                                                            • RJP = never
                                                                                                                                                                                                                                                                                                                                                            • RNP = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                ARD
                                                                                                                                                                                                                                                                                                                                                                | ARP,
                                                                                                                                                                                                                                                                                                                                                                AJD | AJP,
                                                                                                                                                                                                                                                                                                                                                                AND | ANP,
                                                                                                                                                                                                                                                                                                                                                                BRD | BRP,
                                                                                                                                                                                                                                                                                                                                                                BJD | BJP,
                                                                                                                                                                                                                                                                                                                                                                BND | BNP,
                                                                                                                                                                                                                                                                                                                                                                CRD | CRP,
                                                                                                                                                                                                                                                                                                                                                                CJD | CJP,
                                                                                                                                                                                                                                                                                                                                                                CND | CNP,
                                                                                                                                                                                                                                                                                                                                                                RRD | RRP,
                                                                                                                                                                                                                                                                                                                                                                RJD | RJP,
                                                                                                                                                                                                                                                                                                                                                                RND | RNP,
                                                                                                                                                                                                                                                                                                                                                            >

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.6

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.7

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Filter resolve value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +alert( "Value is ( 2*5 = ) 10: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                            var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                            chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARP = never
                                                                                                                                                                                                                                                                                                                                                            • AJP = never
                                                                                                                                                                                                                                                                                                                                                            • ANP = never
                                                                                                                                                                                                                                                                                                                                                            • BRP = never
                                                                                                                                                                                                                                                                                                                                                            • BJP = never
                                                                                                                                                                                                                                                                                                                                                            • BNP = never
                                                                                                                                                                                                                                                                                                                                                            • CRP = never
                                                                                                                                                                                                                                                                                                                                                            • CJP = never
                                                                                                                                                                                                                                                                                                                                                            • CNP = never
                                                                                                                                                                                                                                                                                                                                                            • RRP = never
                                                                                                                                                                                                                                                                                                                                                            • RJP = never
                                                                                                                                                                                                                                                                                                                                                            • RNP = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            • doneFilter: null

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                            • failFilter: null

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                            • OptionalprogressFilter: (
                                                                                                                                                                                                                                                                                                                                                                  t: TN,
                                                                                                                                                                                                                                                                                                                                                                  u: TN,
                                                                                                                                                                                                                                                                                                                                                                  v: TN,
                                                                                                                                                                                                                                                                                                                                                                  ...s: TN[],
                                                                                                                                                                                                                                                                                                                                                              ) =>
                                                                                                                                                                                                                                                                                                                                                                  | ANP
                                                                                                                                                                                                                                                                                                                                                                  | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                  | Thenable<ANP>

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.6

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.7

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                            var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                            chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARD = never
                                                                                                                                                                                                                                                                                                                                                            • AJD = never
                                                                                                                                                                                                                                                                                                                                                            • AND = never
                                                                                                                                                                                                                                                                                                                                                            • BRD = never
                                                                                                                                                                                                                                                                                                                                                            • BJD = never
                                                                                                                                                                                                                                                                                                                                                            • BND = never
                                                                                                                                                                                                                                                                                                                                                            • CRD = never
                                                                                                                                                                                                                                                                                                                                                            • CJD = never
                                                                                                                                                                                                                                                                                                                                                            • CND = never
                                                                                                                                                                                                                                                                                                                                                            • RRD = never
                                                                                                                                                                                                                                                                                                                                                            • RJD = never
                                                                                                                                                                                                                                                                                                                                                            • RND = never
                                                                                                                                                                                                                                                                                                                                                            • ARF = never
                                                                                                                                                                                                                                                                                                                                                            • AJF = never
                                                                                                                                                                                                                                                                                                                                                            • ANF = never
                                                                                                                                                                                                                                                                                                                                                            • BRF = never
                                                                                                                                                                                                                                                                                                                                                            • BJF = never
                                                                                                                                                                                                                                                                                                                                                            • BNF = never
                                                                                                                                                                                                                                                                                                                                                            • CRF = never
                                                                                                                                                                                                                                                                                                                                                            • CJF = never
                                                                                                                                                                                                                                                                                                                                                            • CNF = never
                                                                                                                                                                                                                                                                                                                                                            • RRF = never
                                                                                                                                                                                                                                                                                                                                                            • RJF = never
                                                                                                                                                                                                                                                                                                                                                            • RNF = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                ARD
                                                                                                                                                                                                                                                                                                                                                                | ARF,
                                                                                                                                                                                                                                                                                                                                                                AJD | AJF,
                                                                                                                                                                                                                                                                                                                                                                AND | ANF,
                                                                                                                                                                                                                                                                                                                                                                BRD | BRF,
                                                                                                                                                                                                                                                                                                                                                                BJD | BJF,
                                                                                                                                                                                                                                                                                                                                                                BND | BNF,
                                                                                                                                                                                                                                                                                                                                                                CRD | CRF,
                                                                                                                                                                                                                                                                                                                                                                CJD | CJF,
                                                                                                                                                                                                                                                                                                                                                                CND | CNF,
                                                                                                                                                                                                                                                                                                                                                                RRD | RRF,
                                                                                                                                                                                                                                                                                                                                                                RJD | RJF,
                                                                                                                                                                                                                                                                                                                                                                RND | RNF,
                                                                                                                                                                                                                                                                                                                                                            >

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.6

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.7

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Filter resolve value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +alert( "Value is ( 2*5 = ) 10: " + value ); +}); +``` +@example ​ ````Filter reject value:

                                                                                                                                                                                                                                                                                                                                                            var defer = $.Deferred(),
                                                                                                                                                                                                                                                                                                                                                            filtered = defer.pipe( null, function( value ) {
                                                                                                                                                                                                                                                                                                                                                            return value * 3;
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            defer.reject( 6 );
                                                                                                                                                                                                                                                                                                                                                            filtered.fail(function( value ) {
                                                                                                                                                                                                                                                                                                                                                            alert( "Value is ( 3*6 = ) 18: " + value );
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                            var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                            chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARF = never
                                                                                                                                                                                                                                                                                                                                                            • AJF = never
                                                                                                                                                                                                                                                                                                                                                            • ANF = never
                                                                                                                                                                                                                                                                                                                                                            • BRF = never
                                                                                                                                                                                                                                                                                                                                                            • BJF = never
                                                                                                                                                                                                                                                                                                                                                            • BNF = never
                                                                                                                                                                                                                                                                                                                                                            • CRF = never
                                                                                                                                                                                                                                                                                                                                                            • CJF = never
                                                                                                                                                                                                                                                                                                                                                            • CNF = never
                                                                                                                                                                                                                                                                                                                                                            • RRF = never
                                                                                                                                                                                                                                                                                                                                                            • RJF = never
                                                                                                                                                                                                                                                                                                                                                            • RNF = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            • doneFilter: null

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                            • failFilter: (
                                                                                                                                                                                                                                                                                                                                                                  t: TJ,
                                                                                                                                                                                                                                                                                                                                                                  u: TJ,
                                                                                                                                                                                                                                                                                                                                                                  v: TJ,
                                                                                                                                                                                                                                                                                                                                                                  ...s: TJ[],
                                                                                                                                                                                                                                                                                                                                                              ) =>
                                                                                                                                                                                                                                                                                                                                                                  | AJF
                                                                                                                                                                                                                                                                                                                                                                  | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                  | Thenable<AJF>

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                            • OptionalprogressFilter: null

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.6

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.7

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                            var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                            chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARD = never
                                                                                                                                                                                                                                                                                                                                                            • AJD = never
                                                                                                                                                                                                                                                                                                                                                            • AND = never
                                                                                                                                                                                                                                                                                                                                                            • BRD = never
                                                                                                                                                                                                                                                                                                                                                            • BJD = never
                                                                                                                                                                                                                                                                                                                                                            • BND = never
                                                                                                                                                                                                                                                                                                                                                            • CRD = never
                                                                                                                                                                                                                                                                                                                                                            • CJD = never
                                                                                                                                                                                                                                                                                                                                                            • CND = never
                                                                                                                                                                                                                                                                                                                                                            • RRD = never
                                                                                                                                                                                                                                                                                                                                                            • RJD = never
                                                                                                                                                                                                                                                                                                                                                            • RND = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            • doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                  t: TR,
                                                                                                                                                                                                                                                                                                                                                                  u: TR,
                                                                                                                                                                                                                                                                                                                                                                  v: TR,
                                                                                                                                                                                                                                                                                                                                                                  ...s: TR[],
                                                                                                                                                                                                                                                                                                                                                              ) =>
                                                                                                                                                                                                                                                                                                                                                                  | ARD
                                                                                                                                                                                                                                                                                                                                                                  | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                  | Thenable<ARD>

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                            • OptionalfailFilter: null

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                            • OptionalprogressFilter: null

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.6

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.7

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Filter resolve value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +alert( "Value is ( 2*5 = ) 10: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                            var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                            chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Add handlers to be called when the Deferred object generates progress notifications.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            • progressCallback: TypeOrArray<CallbackBase<TN, TN, TN, TN>>

                                                                                                                                                                                                                                                                                                                                                              A function, or array of functions, to be called when the Deferred generates progress notifications.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                            • ...progressCallbacks: TypeOrArray<CallbackBase<TN, TN, TN, TN>>[]

                                                                                                                                                                                                                                                                                                                                                              Optional additional functions, or arrays of functions, to be called when the Deferred generates +progress notifications.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.progress/">https://api.jquery.com/deferred.progress/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.7

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                          • Return a Deferred's Promise object.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • TTarget extends object

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            • target: TTarget

                                                                                                                                                                                                                                                                                                                                                              Object onto which the promise methods have to be attached

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                            Returns Promise<TR, TJ, TN> & TTarget

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.promise/">https://api.jquery.com/deferred.promise/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.5

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Create a Deferred and set two timer-based functions to either resolve or reject the Deferred after a random interval. Whichever one fires first &quot;wins&quot; and will call one of the callbacks. The second timeout has no effect since the Deferred is already complete (in a resolved or rejected state) from the first timeout action. Also set a timer-based progress notification function, and call a progress handler that adds &quot;working...&quot; to the document body.

                                                                                                                                                                                                                                                                                                                                                            function asyncEvent() {
                                                                                                                                                                                                                                                                                                                                                            var dfd = jQuery.Deferred();
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            // Resolve after a random interval
                                                                                                                                                                                                                                                                                                                                                            setTimeout(function() {
                                                                                                                                                                                                                                                                                                                                                            dfd.resolve( "hurray" );
                                                                                                                                                                                                                                                                                                                                                            }, Math.floor( 400 + Math.random() * 2000 ) );
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            // Reject after a random interval
                                                                                                                                                                                                                                                                                                                                                            setTimeout(function() {
                                                                                                                                                                                                                                                                                                                                                            dfd.reject( "sorry" );
                                                                                                                                                                                                                                                                                                                                                            }, Math.floor( 400 + Math.random() * 2000 ) );
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            // Show a "working..." message every half-second
                                                                                                                                                                                                                                                                                                                                                            setTimeout(function working() {
                                                                                                                                                                                                                                                                                                                                                            if ( dfd.state() === "pending" ) {
                                                                                                                                                                                                                                                                                                                                                            dfd.notify( "working... " );
                                                                                                                                                                                                                                                                                                                                                            setTimeout( working, 500 );
                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                            }, 1 );
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            // Return the Promise so caller can't change the Deferred
                                                                                                                                                                                                                                                                                                                                                            return dfd.promise();
                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            // Attach a done, fail, and progress handler for the asyncEvent
                                                                                                                                                                                                                                                                                                                                                            $.when( asyncEvent() ).then(
                                                                                                                                                                                                                                                                                                                                                            function( status ) {
                                                                                                                                                                                                                                                                                                                                                            alert( status + ", things are going well" );
                                                                                                                                                                                                                                                                                                                                                            },
                                                                                                                                                                                                                                                                                                                                                            function( status ) {
                                                                                                                                                                                                                                                                                                                                                            alert( status + ", you fail this time" );
                                                                                                                                                                                                                                                                                                                                                            },
                                                                                                                                                                                                                                                                                                                                                            function( status ) {
                                                                                                                                                                                                                                                                                                                                                            $( "body" ).append( status );
                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                            );
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Return a Deferred's Promise object.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.promise/">https://api.jquery.com/deferred.promise/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.5

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Use the target argument to promote an existing object to a Promise:

                                                                                                                                                                                                                                                                                                                                                            // Existing object
                                                                                                                                                                                                                                                                                                                                                            var obj = {
                                                                                                                                                                                                                                                                                                                                                            hello: function( name ) {
                                                                                                                                                                                                                                                                                                                                                            alert( "Hello " + name );
                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                            },
                                                                                                                                                                                                                                                                                                                                                            // Create a Deferred
                                                                                                                                                                                                                                                                                                                                                            defer = $.Deferred();
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            // Set object as a promise
                                                                                                                                                                                                                                                                                                                                                            defer.promise( obj );
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            // Resolve the deferred
                                                                                                                                                                                                                                                                                                                                                            defer.resolve( "John" );
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            // Use the object as a Promise
                                                                                                                                                                                                                                                                                                                                                            obj.done(function( name ) {
                                                                                                                                                                                                                                                                                                                                                            obj.hello( name ); // Will alert "Hello John"
                                                                                                                                                                                                                                                                                                                                                            }).hello( "Karl" ); // Will alert "Hello Karl"
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Determine the current state of a Deferred object.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Returns "pending" | "resolved" | "rejected"

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.state/">https://api.jquery.com/deferred.state/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.7

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                          • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARD = never
                                                                                                                                                                                                                                                                                                                                                            • AJD = never
                                                                                                                                                                                                                                                                                                                                                            • AND = never
                                                                                                                                                                                                                                                                                                                                                            • BRD = never
                                                                                                                                                                                                                                                                                                                                                            • BJD = never
                                                                                                                                                                                                                                                                                                                                                            • BND = never
                                                                                                                                                                                                                                                                                                                                                            • CRD = never
                                                                                                                                                                                                                                                                                                                                                            • CJD = never
                                                                                                                                                                                                                                                                                                                                                            • CND = never
                                                                                                                                                                                                                                                                                                                                                            • RRD = never
                                                                                                                                                                                                                                                                                                                                                            • RJD = never
                                                                                                                                                                                                                                                                                                                                                            • RND = never
                                                                                                                                                                                                                                                                                                                                                            • ARF = never
                                                                                                                                                                                                                                                                                                                                                            • AJF = never
                                                                                                                                                                                                                                                                                                                                                            • ANF = never
                                                                                                                                                                                                                                                                                                                                                            • BRF = never
                                                                                                                                                                                                                                                                                                                                                            • BJF = never
                                                                                                                                                                                                                                                                                                                                                            • BNF = never
                                                                                                                                                                                                                                                                                                                                                            • CRF = never
                                                                                                                                                                                                                                                                                                                                                            • CJF = never
                                                                                                                                                                                                                                                                                                                                                            • CNF = never
                                                                                                                                                                                                                                                                                                                                                            • RRF = never
                                                                                                                                                                                                                                                                                                                                                            • RJF = never
                                                                                                                                                                                                                                                                                                                                                            • RNF = never
                                                                                                                                                                                                                                                                                                                                                            • ARP = never
                                                                                                                                                                                                                                                                                                                                                            • AJP = never
                                                                                                                                                                                                                                                                                                                                                            • ANP = never
                                                                                                                                                                                                                                                                                                                                                            • BRP = never
                                                                                                                                                                                                                                                                                                                                                            • BJP = never
                                                                                                                                                                                                                                                                                                                                                            • BNP = never
                                                                                                                                                                                                                                                                                                                                                            • CRP = never
                                                                                                                                                                                                                                                                                                                                                            • CJP = never
                                                                                                                                                                                                                                                                                                                                                            • CNP = never
                                                                                                                                                                                                                                                                                                                                                            • RRP = never
                                                                                                                                                                                                                                                                                                                                                            • RJP = never
                                                                                                                                                                                                                                                                                                                                                            • RNP = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                ARD
                                                                                                                                                                                                                                                                                                                                                                | ARF
                                                                                                                                                                                                                                                                                                                                                                | ARP,
                                                                                                                                                                                                                                                                                                                                                                AJD | AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                AND | ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                BRD | BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                BJD | BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                BND | BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                CRD | CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                CJD | CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                CND | CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                RRD | RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                RJD | RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                RND | RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                            >

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.8

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method. +```javascript +$.get( "test.php" ).then( +function() { +alert( "$.get succeeded" ); +}, function() { +alert( "$.get failed!" ); +} +); +``` +@example ​ ````Filter the resolve value:

                                                                                                                                                                                                                                                                                                                                                            <!doctype html>
                                                                                                                                                                                                                                                                                                                                                            <html lang="en">
                                                                                                                                                                                                                                                                                                                                                            <head>
                                                                                                                                                                                                                                                                                                                                                            <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                            <title>deferred.then demo</title>
                                                                                                                                                                                                                                                                                                                                                            <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                            </head>
                                                                                                                                                                                                                                                                                                                                                            <body>
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            <button>Filter Resolve</button>
                                                                                                                                                                                                                                                                                                                                                            <p></p>
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            <script>
                                                                                                                                                                                                                                                                                                                                                            var filterResolve = function() {
                                                                                                                                                                                                                                                                                                                                                            var defer = $.Deferred(),
                                                                                                                                                                                                                                                                                                                                                            filtered = defer.then(function( value ) {
                                                                                                                                                                                                                                                                                                                                                            return value * 2;
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            defer.resolve( 5 );
                                                                                                                                                                                                                                                                                                                                                            filtered.done(function( value ) {
                                                                                                                                                                                                                                                                                                                                                            $( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            $( "button" ).on( "click", filterResolve );
                                                                                                                                                                                                                                                                                                                                                            </script>
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            </body>
                                                                                                                                                                                                                                                                                                                                                            </html>
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.then( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                            var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                            chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARF = never
                                                                                                                                                                                                                                                                                                                                                            • AJF = never
                                                                                                                                                                                                                                                                                                                                                            • ANF = never
                                                                                                                                                                                                                                                                                                                                                            • BRF = never
                                                                                                                                                                                                                                                                                                                                                            • BJF = never
                                                                                                                                                                                                                                                                                                                                                            • BNF = never
                                                                                                                                                                                                                                                                                                                                                            • CRF = never
                                                                                                                                                                                                                                                                                                                                                            • CJF = never
                                                                                                                                                                                                                                                                                                                                                            • CNF = never
                                                                                                                                                                                                                                                                                                                                                            • RRF = never
                                                                                                                                                                                                                                                                                                                                                            • RJF = never
                                                                                                                                                                                                                                                                                                                                                            • RNF = never
                                                                                                                                                                                                                                                                                                                                                            • ARP = never
                                                                                                                                                                                                                                                                                                                                                            • AJP = never
                                                                                                                                                                                                                                                                                                                                                            • ANP = never
                                                                                                                                                                                                                                                                                                                                                            • BRP = never
                                                                                                                                                                                                                                                                                                                                                            • BJP = never
                                                                                                                                                                                                                                                                                                                                                            • BNP = never
                                                                                                                                                                                                                                                                                                                                                            • CRP = never
                                                                                                                                                                                                                                                                                                                                                            • CJP = never
                                                                                                                                                                                                                                                                                                                                                            • CNP = never
                                                                                                                                                                                                                                                                                                                                                            • RRP = never
                                                                                                                                                                                                                                                                                                                                                            • RJP = never
                                                                                                                                                                                                                                                                                                                                                            • RNP = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                ARF
                                                                                                                                                                                                                                                                                                                                                                | ARP,
                                                                                                                                                                                                                                                                                                                                                                AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                            >

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.8

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.then( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                            var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                            chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARD = never
                                                                                                                                                                                                                                                                                                                                                            • AJD = never
                                                                                                                                                                                                                                                                                                                                                            • AND = never
                                                                                                                                                                                                                                                                                                                                                            • BRD = never
                                                                                                                                                                                                                                                                                                                                                            • BJD = never
                                                                                                                                                                                                                                                                                                                                                            • BND = never
                                                                                                                                                                                                                                                                                                                                                            • CRD = never
                                                                                                                                                                                                                                                                                                                                                            • CJD = never
                                                                                                                                                                                                                                                                                                                                                            • CND = never
                                                                                                                                                                                                                                                                                                                                                            • RRD = never
                                                                                                                                                                                                                                                                                                                                                            • RJD = never
                                                                                                                                                                                                                                                                                                                                                            • RND = never
                                                                                                                                                                                                                                                                                                                                                            • ARP = never
                                                                                                                                                                                                                                                                                                                                                            • AJP = never
                                                                                                                                                                                                                                                                                                                                                            • ANP = never
                                                                                                                                                                                                                                                                                                                                                            • BRP = never
                                                                                                                                                                                                                                                                                                                                                            • BJP = never
                                                                                                                                                                                                                                                                                                                                                            • BNP = never
                                                                                                                                                                                                                                                                                                                                                            • CRP = never
                                                                                                                                                                                                                                                                                                                                                            • CJP = never
                                                                                                                                                                                                                                                                                                                                                            • CNP = never
                                                                                                                                                                                                                                                                                                                                                            • RRP = never
                                                                                                                                                                                                                                                                                                                                                            • RJP = never
                                                                                                                                                                                                                                                                                                                                                            • RNP = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                ARD
                                                                                                                                                                                                                                                                                                                                                                | ARP,
                                                                                                                                                                                                                                                                                                                                                                AJD | AJP,
                                                                                                                                                                                                                                                                                                                                                                AND | ANP,
                                                                                                                                                                                                                                                                                                                                                                BRD | BRP,
                                                                                                                                                                                                                                                                                                                                                                BJD | BJP,
                                                                                                                                                                                                                                                                                                                                                                BND | BNP,
                                                                                                                                                                                                                                                                                                                                                                CRD | CRP,
                                                                                                                                                                                                                                                                                                                                                                CJD | CJP,
                                                                                                                                                                                                                                                                                                                                                                CND | CNP,
                                                                                                                                                                                                                                                                                                                                                                RRD | RRP,
                                                                                                                                                                                                                                                                                                                                                                RJD | RJP,
                                                                                                                                                                                                                                                                                                                                                                RND | RNP,
                                                                                                                                                                                                                                                                                                                                                            >

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.8

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Filter the resolve value: +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>deferred.then demo</title> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<button>Filter Resolve</button> +<p></p> +​ +<script> +var filterResolve = function() { +var defer = $.Deferred(), +filtered = defer.then(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +$( "p" ).html( "Value is ( 2*5 = ) 10: " + value ); +}); +}; +​ +$( "button" ).on( "click", filterResolve ); +</script> +​ +</body> +</html> +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                            var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                            chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARP = never
                                                                                                                                                                                                                                                                                                                                                            • AJP = never
                                                                                                                                                                                                                                                                                                                                                            • ANP = never
                                                                                                                                                                                                                                                                                                                                                            • BRP = never
                                                                                                                                                                                                                                                                                                                                                            • BJP = never
                                                                                                                                                                                                                                                                                                                                                            • BNP = never
                                                                                                                                                                                                                                                                                                                                                            • CRP = never
                                                                                                                                                                                                                                                                                                                                                            • CJP = never
                                                                                                                                                                                                                                                                                                                                                            • CNP = never
                                                                                                                                                                                                                                                                                                                                                            • RRP = never
                                                                                                                                                                                                                                                                                                                                                            • RJP = never
                                                                                                                                                                                                                                                                                                                                                            • RNP = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            • doneFilter: null

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                            • failFilter: null

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                            • OptionalprogressFilter: (
                                                                                                                                                                                                                                                                                                                                                                  t: TN,
                                                                                                                                                                                                                                                                                                                                                                  u: TN,
                                                                                                                                                                                                                                                                                                                                                                  v: TN,
                                                                                                                                                                                                                                                                                                                                                                  ...s: TN[],
                                                                                                                                                                                                                                                                                                                                                              ) =>
                                                                                                                                                                                                                                                                                                                                                                  | ANP
                                                                                                                                                                                                                                                                                                                                                                  | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                  | Thenable<ANP>

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.8

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                            var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                            chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARD = never
                                                                                                                                                                                                                                                                                                                                                            • AJD = never
                                                                                                                                                                                                                                                                                                                                                            • AND = never
                                                                                                                                                                                                                                                                                                                                                            • BRD = never
                                                                                                                                                                                                                                                                                                                                                            • BJD = never
                                                                                                                                                                                                                                                                                                                                                            • BND = never
                                                                                                                                                                                                                                                                                                                                                            • CRD = never
                                                                                                                                                                                                                                                                                                                                                            • CJD = never
                                                                                                                                                                                                                                                                                                                                                            • CND = never
                                                                                                                                                                                                                                                                                                                                                            • RRD = never
                                                                                                                                                                                                                                                                                                                                                            • RJD = never
                                                                                                                                                                                                                                                                                                                                                            • RND = never
                                                                                                                                                                                                                                                                                                                                                            • ARF = never
                                                                                                                                                                                                                                                                                                                                                            • AJF = never
                                                                                                                                                                                                                                                                                                                                                            • ANF = never
                                                                                                                                                                                                                                                                                                                                                            • BRF = never
                                                                                                                                                                                                                                                                                                                                                            • BJF = never
                                                                                                                                                                                                                                                                                                                                                            • BNF = never
                                                                                                                                                                                                                                                                                                                                                            • CRF = never
                                                                                                                                                                                                                                                                                                                                                            • CJF = never
                                                                                                                                                                                                                                                                                                                                                            • CNF = never
                                                                                                                                                                                                                                                                                                                                                            • RRF = never
                                                                                                                                                                                                                                                                                                                                                            • RJF = never
                                                                                                                                                                                                                                                                                                                                                            • RNF = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                ARD
                                                                                                                                                                                                                                                                                                                                                                | ARF,
                                                                                                                                                                                                                                                                                                                                                                AJD | AJF,
                                                                                                                                                                                                                                                                                                                                                                AND | ANF,
                                                                                                                                                                                                                                                                                                                                                                BRD | BRF,
                                                                                                                                                                                                                                                                                                                                                                BJD | BJF,
                                                                                                                                                                                                                                                                                                                                                                BND | BNF,
                                                                                                                                                                                                                                                                                                                                                                CRD | CRF,
                                                                                                                                                                                                                                                                                                                                                                CJD | CJF,
                                                                                                                                                                                                                                                                                                                                                                CND | CNF,
                                                                                                                                                                                                                                                                                                                                                                RRD | RRF,
                                                                                                                                                                                                                                                                                                                                                                RJD | RJF,
                                                                                                                                                                                                                                                                                                                                                                RND | RNF,
                                                                                                                                                                                                                                                                                                                                                            >

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.8

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method. +```javascript +$.get( "test.php" ).then( +function() { +alert( "$.get succeeded" ); +}, function() { +alert( "$.get failed!" ); +} +); +``` +@example ​ ````Filter the resolve value:

                                                                                                                                                                                                                                                                                                                                                            <!doctype html>
                                                                                                                                                                                                                                                                                                                                                            <html lang="en">
                                                                                                                                                                                                                                                                                                                                                            <head>
                                                                                                                                                                                                                                                                                                                                                            <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                            <title>deferred.then demo</title>
                                                                                                                                                                                                                                                                                                                                                            <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                            </head>
                                                                                                                                                                                                                                                                                                                                                            <body>
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            <button>Filter Resolve</button>
                                                                                                                                                                                                                                                                                                                                                            <p></p>
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            <script>
                                                                                                                                                                                                                                                                                                                                                            var filterResolve = function() {
                                                                                                                                                                                                                                                                                                                                                            var defer = $.Deferred(),
                                                                                                                                                                                                                                                                                                                                                            filtered = defer.then(function( value ) {
                                                                                                                                                                                                                                                                                                                                                            return value * 2;
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            defer.resolve( 5 );
                                                                                                                                                                                                                                                                                                                                                            filtered.done(function( value ) {
                                                                                                                                                                                                                                                                                                                                                            $( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            $( "button" ).on( "click", filterResolve );
                                                                                                                                                                                                                                                                                                                                                            </script>
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            </body>
                                                                                                                                                                                                                                                                                                                                                            </html>
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.then( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                            var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                            chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARF = never
                                                                                                                                                                                                                                                                                                                                                            • AJF = never
                                                                                                                                                                                                                                                                                                                                                            • ANF = never
                                                                                                                                                                                                                                                                                                                                                            • BRF = never
                                                                                                                                                                                                                                                                                                                                                            • BJF = never
                                                                                                                                                                                                                                                                                                                                                            • BNF = never
                                                                                                                                                                                                                                                                                                                                                            • CRF = never
                                                                                                                                                                                                                                                                                                                                                            • CJF = never
                                                                                                                                                                                                                                                                                                                                                            • CNF = never
                                                                                                                                                                                                                                                                                                                                                            • RRF = never
                                                                                                                                                                                                                                                                                                                                                            • RJF = never
                                                                                                                                                                                                                                                                                                                                                            • RNF = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            • doneFilter: null

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                            • failFilter: (
                                                                                                                                                                                                                                                                                                                                                                  t: TJ,
                                                                                                                                                                                                                                                                                                                                                                  u: TJ,
                                                                                                                                                                                                                                                                                                                                                                  v: TJ,
                                                                                                                                                                                                                                                                                                                                                                  ...s: TJ[],
                                                                                                                                                                                                                                                                                                                                                              ) =>
                                                                                                                                                                                                                                                                                                                                                                  | ARF
                                                                                                                                                                                                                                                                                                                                                                  | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                  | Thenable<ARF>

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                            • OptionalprogressFilter: null

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.8

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.then( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                            var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                            chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • ARD = never
                                                                                                                                                                                                                                                                                                                                                            • AJD = never
                                                                                                                                                                                                                                                                                                                                                            • AND = never
                                                                                                                                                                                                                                                                                                                                                            • BRD = never
                                                                                                                                                                                                                                                                                                                                                            • BJD = never
                                                                                                                                                                                                                                                                                                                                                            • BND = never
                                                                                                                                                                                                                                                                                                                                                            • CRD = never
                                                                                                                                                                                                                                                                                                                                                            • CJD = never
                                                                                                                                                                                                                                                                                                                                                            • CND = never
                                                                                                                                                                                                                                                                                                                                                            • RRD = never
                                                                                                                                                                                                                                                                                                                                                            • RJD = never
                                                                                                                                                                                                                                                                                                                                                            • RND = never

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            • doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                  t: TR,
                                                                                                                                                                                                                                                                                                                                                                  u: TR,
                                                                                                                                                                                                                                                                                                                                                                  v: TR,
                                                                                                                                                                                                                                                                                                                                                                  ...s: TR[],
                                                                                                                                                                                                                                                                                                                                                              ) =>
                                                                                                                                                                                                                                                                                                                                                                  | ARD
                                                                                                                                                                                                                                                                                                                                                                  | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                  | Thenable<ARD>

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                            • OptionalfailFilter: null

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                            • OptionalprogressFilter: null

                                                                                                                                                                                                                                                                                                                                                              An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                            Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            1.8

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Example: ​ ````Filter the resolve value: +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>deferred.then demo</title> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<button>Filter Resolve</button> +<p></p> +​ +<script> +var filterResolve = function() { +var defer = $.Deferred(), +filtered = defer.then(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +$( "p" ).html( "Value is ( 2*5 = ) 10: " + value ); +}); +}; +​ +$( "button" ).on( "click", filterResolve ); +</script> +​ +</body> +</html> +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                            var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                            chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            ​
                                                                                                                                                                                                                                                                                                                                                            chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                            // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                            });
+
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.PromiseBase.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.PromiseBase.html new file mode 100644 index 000000000..11aa3c67b --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.PromiseBase.html @@ -0,0 +1,443 @@ +PromiseBase | trilium
                                                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                            Interface PromiseBase<TR, TJ, TN, UR, UJ, UN, VR, VJ, VN, SR, SJ, SN>

                                                                                                                                                                                                                                                                                                                                                            This object provides a subset of the methods of the Deferred object (then, done, fail, always, pipe, progress, state and promise) to prevent users from changing the state of the Deferred.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            <a href="https://api.jquery.com/Types/#Promise">https://api.jquery.com/Types/#Promise</a>

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            interface PromiseBase<TR, TJ, TN, UR, UJ, UN, VR, VJ, VN, SR, SJ, SN> {
                                                                                                                                                                                                                                                                                                                                                                always(
                                                                                                                                                                                                                                                                                                                                                                    alwaysCallback: TypeOrArray<
                                                                                                                                                                                                                                                                                                                                                                        CallbackBase<TR | TJ, UR | UJ, VR | VJ, SR | SJ>,
                                                                                                                                                                                                                                                                                                                                                                    >,
                                                                                                                                                                                                                                                                                                                                                                    ...alwaysCallbacks: TypeOrArray<
                                                                                                                                                                                                                                                                                                                                                                        CallbackBase<TR | TJ, UR | UJ, VR | VJ, SR | SJ>,
                                                                                                                                                                                                                                                                                                                                                                    >[],
                                                                                                                                                                                                                                                                                                                                                                ): this;
                                                                                                                                                                                                                                                                                                                                                                catch<
                                                                                                                                                                                                                                                                                                                                                                    ARF = never,
                                                                                                                                                                                                                                                                                                                                                                    AJF = never,
                                                                                                                                                                                                                                                                                                                                                                    ANF = never,
                                                                                                                                                                                                                                                                                                                                                                    BRF = never,
                                                                                                                                                                                                                                                                                                                                                                    BJF = never,
                                                                                                                                                                                                                                                                                                                                                                    BNF = never,
                                                                                                                                                                                                                                                                                                                                                                    CRF = never,
                                                                                                                                                                                                                                                                                                                                                                    CJF = never,
                                                                                                                                                                                                                                                                                                                                                                    CNF = never,
                                                                                                                                                                                                                                                                                                                                                                    RRF = never,
                                                                                                                                                                                                                                                                                                                                                                    RJF = never,
                                                                                                                                                                                                                                                                                                                                                                    RNF = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    failFilter?:
                                                                                                                                                                                                                                                                                                                                                                        | null
                                                                                                                                                                                                                                                                                                                                                                        | (
                                                                                                                                                                                                                                                                                                                                                                            (
                                                                                                                                                                                                                                                                                                                                                                                t: TJ,
                                                                                                                                                                                                                                                                                                                                                                                u: UJ,
                                                                                                                                                                                                                                                                                                                                                                                v: VJ,
                                                                                                                                                                                                                                                                                                                                                                                ...s: SJ[],
                                                                                                                                                                                                                                                                                                                                                                            ) =>
                                                                                                                                                                                                                                                                                                                                                                                | ARF
                                                                                                                                                                                                                                                                                                                                                                                | PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                                    ARF,
                                                                                                                                                                                                                                                                                                                                                                                    AJF,
                                                                                                                                                                                                                                                                                                                                                                                    ANF,
                                                                                                                                                                                                                                                                                                                                                                                    BRF,
                                                                                                                                                                                                                                                                                                                                                                                    BJF,
                                                                                                                                                                                                                                                                                                                                                                                    BNF,
                                                                                                                                                                                                                                                                                                                                                                                    CRF,
                                                                                                                                                                                                                                                                                                                                                                                    CJF,
                                                                                                                                                                                                                                                                                                                                                                                    CNF,
                                                                                                                                                                                                                                                                                                                                                                                    RRF,
                                                                                                                                                                                                                                                                                                                                                                                    RJF,
                                                                                                                                                                                                                                                                                                                                                                                    RNF,
                                                                                                                                                                                                                                                                                                                                                                                >
                                                                                                                                                                                                                                                                                                                                                                                | Thenable<ARF>
                                                                                                                                                                                                                                                                                                                                                                        ),
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>;
                                                                                                                                                                                                                                                                                                                                                                done(
                                                                                                                                                                                                                                                                                                                                                                    doneCallback: TypeOrArray<CallbackBase<TR, UR, VR, SR>>,
                                                                                                                                                                                                                                                                                                                                                                    ...doneCallbacks: TypeOrArray<CallbackBase<TR, UR, VR, SR>>[],
                                                                                                                                                                                                                                                                                                                                                                ): this;
                                                                                                                                                                                                                                                                                                                                                                fail(
                                                                                                                                                                                                                                                                                                                                                                    failCallback: TypeOrArray<CallbackBase<TJ, UJ, VJ, SJ>>,
                                                                                                                                                                                                                                                                                                                                                                    ...failCallbacks: TypeOrArray<CallbackBase<TJ, UJ, VJ, SJ>>[],
                                                                                                                                                                                                                                                                                                                                                                ): this;
                                                                                                                                                                                                                                                                                                                                                                pipe<
                                                                                                                                                                                                                                                                                                                                                                    ARD = never,
                                                                                                                                                                                                                                                                                                                                                                    AJD = never,
                                                                                                                                                                                                                                                                                                                                                                    AND = never,
                                                                                                                                                                                                                                                                                                                                                                    BRD = never,
                                                                                                                                                                                                                                                                                                                                                                    BJD = never,
                                                                                                                                                                                                                                                                                                                                                                    BND = never,
                                                                                                                                                                                                                                                                                                                                                                    CRD = never,
                                                                                                                                                                                                                                                                                                                                                                    CJD = never,
                                                                                                                                                                                                                                                                                                                                                                    CND = never,
                                                                                                                                                                                                                                                                                                                                                                    RRD = never,
                                                                                                                                                                                                                                                                                                                                                                    RJD = never,
                                                                                                                                                                                                                                                                                                                                                                    RND = never,
                                                                                                                                                                                                                                                                                                                                                                    ARF = never,
                                                                                                                                                                                                                                                                                                                                                                    AJF = never,
                                                                                                                                                                                                                                                                                                                                                                    ANF = never,
                                                                                                                                                                                                                                                                                                                                                                    BRF = never,
                                                                                                                                                                                                                                                                                                                                                                    BJF = never,
                                                                                                                                                                                                                                                                                                                                                                    BNF = never,
                                                                                                                                                                                                                                                                                                                                                                    CRF = never,
                                                                                                                                                                                                                                                                                                                                                                    CJF = never,
                                                                                                                                                                                                                                                                                                                                                                    CNF = never,
                                                                                                                                                                                                                                                                                                                                                                    RRF = never,
                                                                                                                                                                                                                                                                                                                                                                    RJF = never,
                                                                                                                                                                                                                                                                                                                                                                    RNF = never,
                                                                                                                                                                                                                                                                                                                                                                    ARP = never,
                                                                                                                                                                                                                                                                                                                                                                    AJP = never,
                                                                                                                                                                                                                                                                                                                                                                    ANP = never,
                                                                                                                                                                                                                                                                                                                                                                    BRP = never,
                                                                                                                                                                                                                                                                                                                                                                    BJP = never,
                                                                                                                                                                                                                                                                                                                                                                    BNP = never,
                                                                                                                                                                                                                                                                                                                                                                    CRP = never,
                                                                                                                                                                                                                                                                                                                                                                    CJP = never,
                                                                                                                                                                                                                                                                                                                                                                    CNP = never,
                                                                                                                                                                                                                                                                                                                                                                    RRP = never,
                                                                                                                                                                                                                                                                                                                                                                    RJP = never,
                                                                                                                                                                                                                                                                                                                                                                    RNP = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TR,
                                                                                                                                                                                                                                                                                                                                                                        u: UR,
                                                                                                                                                                                                                                                                                                                                                                        v: VR,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SR[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ARD
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                    failFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TJ,
                                                                                                                                                                                                                                                                                                                                                                        u: UJ,
                                                                                                                                                                                                                                                                                                                                                                        v: VJ,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SJ[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | AJF
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<AJF>,
                                                                                                                                                                                                                                                                                                                                                                    progressFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TN,
                                                                                                                                                                                                                                                                                                                                                                        u: UN,
                                                                                                                                                                                                                                                                                                                                                                        v: VN,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SN[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ANP
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                    ARD
                                                                                                                                                                                                                                                                                                                                                                    | ARF
                                                                                                                                                                                                                                                                                                                                                                    | ARP,
                                                                                                                                                                                                                                                                                                                                                                    AJD | AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                    AND | ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                    BRD | BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                    BJD | BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                    BND | BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                    CRD | CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                    CJD | CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                    CND | CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                    RRD | RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                    RJD | RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                    RND | RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                                >;
                                                                                                                                                                                                                                                                                                                                                                pipe<
                                                                                                                                                                                                                                                                                                                                                                    ARF = never,
                                                                                                                                                                                                                                                                                                                                                                    AJF = never,
                                                                                                                                                                                                                                                                                                                                                                    ANF = never,
                                                                                                                                                                                                                                                                                                                                                                    BRF = never,
                                                                                                                                                                                                                                                                                                                                                                    BJF = never,
                                                                                                                                                                                                                                                                                                                                                                    BNF = never,
                                                                                                                                                                                                                                                                                                                                                                    CRF = never,
                                                                                                                                                                                                                                                                                                                                                                    CJF = never,
                                                                                                                                                                                                                                                                                                                                                                    CNF = never,
                                                                                                                                                                                                                                                                                                                                                                    RRF = never,
                                                                                                                                                                                                                                                                                                                                                                    RJF = never,
                                                                                                                                                                                                                                                                                                                                                                    RNF = never,
                                                                                                                                                                                                                                                                                                                                                                    ARP = never,
                                                                                                                                                                                                                                                                                                                                                                    AJP = never,
                                                                                                                                                                                                                                                                                                                                                                    ANP = never,
                                                                                                                                                                                                                                                                                                                                                                    BRP = never,
                                                                                                                                                                                                                                                                                                                                                                    BJP = never,
                                                                                                                                                                                                                                                                                                                                                                    BNP = never,
                                                                                                                                                                                                                                                                                                                                                                    CRP = never,
                                                                                                                                                                                                                                                                                                                                                                    CJP = never,
                                                                                                                                                                                                                                                                                                                                                                    CNP = never,
                                                                                                                                                                                                                                                                                                                                                                    RRP = never,
                                                                                                                                                                                                                                                                                                                                                                    RJP = never,
                                                                                                                                                                                                                                                                                                                                                                    RNP = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    doneFilter: null,
                                                                                                                                                                                                                                                                                                                                                                    failFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TJ,
                                                                                                                                                                                                                                                                                                                                                                        u: UJ,
                                                                                                                                                                                                                                                                                                                                                                        v: VJ,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SJ[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | AJF
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<AJF>,
                                                                                                                                                                                                                                                                                                                                                                    progressFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TN,
                                                                                                                                                                                                                                                                                                                                                                        u: UN,
                                                                                                                                                                                                                                                                                                                                                                        v: VN,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SN[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ANP
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                    ARF
                                                                                                                                                                                                                                                                                                                                                                    | ARP,
                                                                                                                                                                                                                                                                                                                                                                    AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                    ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                    BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                    BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                    BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                    CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                    CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                    CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                    RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                    RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                    RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                                >;
                                                                                                                                                                                                                                                                                                                                                                pipe<
                                                                                                                                                                                                                                                                                                                                                                    ARD = never,
                                                                                                                                                                                                                                                                                                                                                                    AJD = never,
                                                                                                                                                                                                                                                                                                                                                                    AND = never,
                                                                                                                                                                                                                                                                                                                                                                    BRD = never,
                                                                                                                                                                                                                                                                                                                                                                    BJD = never,
                                                                                                                                                                                                                                                                                                                                                                    BND = never,
                                                                                                                                                                                                                                                                                                                                                                    CRD = never,
                                                                                                                                                                                                                                                                                                                                                                    CJD = never,
                                                                                                                                                                                                                                                                                                                                                                    CND = never,
                                                                                                                                                                                                                                                                                                                                                                    RRD = never,
                                                                                                                                                                                                                                                                                                                                                                    RJD = never,
                                                                                                                                                                                                                                                                                                                                                                    RND = never,
                                                                                                                                                                                                                                                                                                                                                                    ARP = never,
                                                                                                                                                                                                                                                                                                                                                                    AJP = never,
                                                                                                                                                                                                                                                                                                                                                                    ANP = never,
                                                                                                                                                                                                                                                                                                                                                                    BRP = never,
                                                                                                                                                                                                                                                                                                                                                                    BJP = never,
                                                                                                                                                                                                                                                                                                                                                                    BNP = never,
                                                                                                                                                                                                                                                                                                                                                                    CRP = never,
                                                                                                                                                                                                                                                                                                                                                                    CJP = never,
                                                                                                                                                                                                                                                                                                                                                                    CNP = never,
                                                                                                                                                                                                                                                                                                                                                                    RRP = never,
                                                                                                                                                                                                                                                                                                                                                                    RJP = never,
                                                                                                                                                                                                                                                                                                                                                                    RNP = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TR,
                                                                                                                                                                                                                                                                                                                                                                        u: UR,
                                                                                                                                                                                                                                                                                                                                                                        v: VR,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SR[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ARD
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                    failFilter: null,
                                                                                                                                                                                                                                                                                                                                                                    progressFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TN,
                                                                                                                                                                                                                                                                                                                                                                        u: UN,
                                                                                                                                                                                                                                                                                                                                                                        v: VN,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SN[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ANP
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                    ARD
                                                                                                                                                                                                                                                                                                                                                                    | ARP,
                                                                                                                                                                                                                                                                                                                                                                    AJD | AJP,
                                                                                                                                                                                                                                                                                                                                                                    AND | ANP,
                                                                                                                                                                                                                                                                                                                                                                    BRD | BRP,
                                                                                                                                                                                                                                                                                                                                                                    BJD | BJP,
                                                                                                                                                                                                                                                                                                                                                                    BND | BNP,
                                                                                                                                                                                                                                                                                                                                                                    CRD | CRP,
                                                                                                                                                                                                                                                                                                                                                                    CJD | CJP,
                                                                                                                                                                                                                                                                                                                                                                    CND | CNP,
                                                                                                                                                                                                                                                                                                                                                                    RRD | RRP,
                                                                                                                                                                                                                                                                                                                                                                    RJD | RJP,
                                                                                                                                                                                                                                                                                                                                                                    RND | RNP,
                                                                                                                                                                                                                                                                                                                                                                >;
                                                                                                                                                                                                                                                                                                                                                                pipe<
                                                                                                                                                                                                                                                                                                                                                                    ARP = never,
                                                                                                                                                                                                                                                                                                                                                                    AJP = never,
                                                                                                                                                                                                                                                                                                                                                                    ANP = never,
                                                                                                                                                                                                                                                                                                                                                                    BRP = never,
                                                                                                                                                                                                                                                                                                                                                                    BJP = never,
                                                                                                                                                                                                                                                                                                                                                                    BNP = never,
                                                                                                                                                                                                                                                                                                                                                                    CRP = never,
                                                                                                                                                                                                                                                                                                                                                                    CJP = never,
                                                                                                                                                                                                                                                                                                                                                                    CNP = never,
                                                                                                                                                                                                                                                                                                                                                                    RRP = never,
                                                                                                                                                                                                                                                                                                                                                                    RJP = never,
                                                                                                                                                                                                                                                                                                                                                                    RNP = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    doneFilter: null,
                                                                                                                                                                                                                                                                                                                                                                    failFilter: null,
                                                                                                                                                                                                                                                                                                                                                                    progressFilter?: (
                                                                                                                                                                                                                                                                                                                                                                        t: TN,
                                                                                                                                                                                                                                                                                                                                                                        u: UN,
                                                                                                                                                                                                                                                                                                                                                                        v: VN,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SN[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ANP
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>;
                                                                                                                                                                                                                                                                                                                                                                pipe<
                                                                                                                                                                                                                                                                                                                                                                    ARD = never,
                                                                                                                                                                                                                                                                                                                                                                    AJD = never,
                                                                                                                                                                                                                                                                                                                                                                    AND = never,
                                                                                                                                                                                                                                                                                                                                                                    BRD = never,
                                                                                                                                                                                                                                                                                                                                                                    BJD = never,
                                                                                                                                                                                                                                                                                                                                                                    BND = never,
                                                                                                                                                                                                                                                                                                                                                                    CRD = never,
                                                                                                                                                                                                                                                                                                                                                                    CJD = never,
                                                                                                                                                                                                                                                                                                                                                                    CND = never,
                                                                                                                                                                                                                                                                                                                                                                    RRD = never,
                                                                                                                                                                                                                                                                                                                                                                    RJD = never,
                                                                                                                                                                                                                                                                                                                                                                    RND = never,
                                                                                                                                                                                                                                                                                                                                                                    ARF = never,
                                                                                                                                                                                                                                                                                                                                                                    AJF = never,
                                                                                                                                                                                                                                                                                                                                                                    ANF = never,
                                                                                                                                                                                                                                                                                                                                                                    BRF = never,
                                                                                                                                                                                                                                                                                                                                                                    BJF = never,
                                                                                                                                                                                                                                                                                                                                                                    BNF = never,
                                                                                                                                                                                                                                                                                                                                                                    CRF = never,
                                                                                                                                                                                                                                                                                                                                                                    CJF = never,
                                                                                                                                                                                                                                                                                                                                                                    CNF = never,
                                                                                                                                                                                                                                                                                                                                                                    RRF = never,
                                                                                                                                                                                                                                                                                                                                                                    RJF = never,
                                                                                                                                                                                                                                                                                                                                                                    RNF = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TR,
                                                                                                                                                                                                                                                                                                                                                                        u: UR,
                                                                                                                                                                                                                                                                                                                                                                        v: VR,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SR[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ARD
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                    failFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TJ,
                                                                                                                                                                                                                                                                                                                                                                        u: UJ,
                                                                                                                                                                                                                                                                                                                                                                        v: VJ,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SJ[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | AJF
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<AJF>,
                                                                                                                                                                                                                                                                                                                                                                    progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                    ARD
                                                                                                                                                                                                                                                                                                                                                                    | ARF,
                                                                                                                                                                                                                                                                                                                                                                    AJD | AJF,
                                                                                                                                                                                                                                                                                                                                                                    AND | ANF,
                                                                                                                                                                                                                                                                                                                                                                    BRD | BRF,
                                                                                                                                                                                                                                                                                                                                                                    BJD | BJF,
                                                                                                                                                                                                                                                                                                                                                                    BND | BNF,
                                                                                                                                                                                                                                                                                                                                                                    CRD | CRF,
                                                                                                                                                                                                                                                                                                                                                                    CJD | CJF,
                                                                                                                                                                                                                                                                                                                                                                    CND | CNF,
                                                                                                                                                                                                                                                                                                                                                                    RRD | RRF,
                                                                                                                                                                                                                                                                                                                                                                    RJD | RJF,
                                                                                                                                                                                                                                                                                                                                                                    RND | RNF,
                                                                                                                                                                                                                                                                                                                                                                >;
                                                                                                                                                                                                                                                                                                                                                                pipe<
                                                                                                                                                                                                                                                                                                                                                                    ARF = never,
                                                                                                                                                                                                                                                                                                                                                                    AJF = never,
                                                                                                                                                                                                                                                                                                                                                                    ANF = never,
                                                                                                                                                                                                                                                                                                                                                                    BRF = never,
                                                                                                                                                                                                                                                                                                                                                                    BJF = never,
                                                                                                                                                                                                                                                                                                                                                                    BNF = never,
                                                                                                                                                                                                                                                                                                                                                                    CRF = never,
                                                                                                                                                                                                                                                                                                                                                                    CJF = never,
                                                                                                                                                                                                                                                                                                                                                                    CNF = never,
                                                                                                                                                                                                                                                                                                                                                                    RRF = never,
                                                                                                                                                                                                                                                                                                                                                                    RJF = never,
                                                                                                                                                                                                                                                                                                                                                                    RNF = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    doneFilter: null,
                                                                                                                                                                                                                                                                                                                                                                    failFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TJ,
                                                                                                                                                                                                                                                                                                                                                                        u: UJ,
                                                                                                                                                                                                                                                                                                                                                                        v: VJ,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SJ[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | AJF
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<AJF>,
                                                                                                                                                                                                                                                                                                                                                                    progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>;
                                                                                                                                                                                                                                                                                                                                                                pipe<
                                                                                                                                                                                                                                                                                                                                                                    ARD = never,
                                                                                                                                                                                                                                                                                                                                                                    AJD = never,
                                                                                                                                                                                                                                                                                                                                                                    AND = never,
                                                                                                                                                                                                                                                                                                                                                                    BRD = never,
                                                                                                                                                                                                                                                                                                                                                                    BJD = never,
                                                                                                                                                                                                                                                                                                                                                                    BND = never,
                                                                                                                                                                                                                                                                                                                                                                    CRD = never,
                                                                                                                                                                                                                                                                                                                                                                    CJD = never,
                                                                                                                                                                                                                                                                                                                                                                    CND = never,
                                                                                                                                                                                                                                                                                                                                                                    RRD = never,
                                                                                                                                                                                                                                                                                                                                                                    RJD = never,
                                                                                                                                                                                                                                                                                                                                                                    RND = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TR,
                                                                                                                                                                                                                                                                                                                                                                        u: UR,
                                                                                                                                                                                                                                                                                                                                                                        v: VR,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SR[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ARD
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                    failFilter?: null,
                                                                                                                                                                                                                                                                                                                                                                    progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>;
                                                                                                                                                                                                                                                                                                                                                                progress(
                                                                                                                                                                                                                                                                                                                                                                    progressCallback: TypeOrArray<CallbackBase<TN, UN, VN, SN>>,
                                                                                                                                                                                                                                                                                                                                                                    ...progressCallbacks: TypeOrArray<CallbackBase<TN, UN, VN, SN>>[],
                                                                                                                                                                                                                                                                                                                                                                ): this;
                                                                                                                                                                                                                                                                                                                                                                promise<TTarget extends object>(
                                                                                                                                                                                                                                                                                                                                                                    target: TTarget,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<TR, TJ, TN, UR, UJ, UN, VR, VJ, VN, SR, SJ, SN> & TTarget;
                                                                                                                                                                                                                                                                                                                                                                promise(): this;
                                                                                                                                                                                                                                                                                                                                                                state(): "pending" | "resolved" | "rejected";
                                                                                                                                                                                                                                                                                                                                                                then<
                                                                                                                                                                                                                                                                                                                                                                    ARD = never,
                                                                                                                                                                                                                                                                                                                                                                    AJD = never,
                                                                                                                                                                                                                                                                                                                                                                    AND = never,
                                                                                                                                                                                                                                                                                                                                                                    BRD = never,
                                                                                                                                                                                                                                                                                                                                                                    BJD = never,
                                                                                                                                                                                                                                                                                                                                                                    BND = never,
                                                                                                                                                                                                                                                                                                                                                                    CRD = never,
                                                                                                                                                                                                                                                                                                                                                                    CJD = never,
                                                                                                                                                                                                                                                                                                                                                                    CND = never,
                                                                                                                                                                                                                                                                                                                                                                    RRD = never,
                                                                                                                                                                                                                                                                                                                                                                    RJD = never,
                                                                                                                                                                                                                                                                                                                                                                    RND = never,
                                                                                                                                                                                                                                                                                                                                                                    ARF = never,
                                                                                                                                                                                                                                                                                                                                                                    AJF = never,
                                                                                                                                                                                                                                                                                                                                                                    ANF = never,
                                                                                                                                                                                                                                                                                                                                                                    BRF = never,
                                                                                                                                                                                                                                                                                                                                                                    BJF = never,
                                                                                                                                                                                                                                                                                                                                                                    BNF = never,
                                                                                                                                                                                                                                                                                                                                                                    CRF = never,
                                                                                                                                                                                                                                                                                                                                                                    CJF = never,
                                                                                                                                                                                                                                                                                                                                                                    CNF = never,
                                                                                                                                                                                                                                                                                                                                                                    RRF = never,
                                                                                                                                                                                                                                                                                                                                                                    RJF = never,
                                                                                                                                                                                                                                                                                                                                                                    RNF = never,
                                                                                                                                                                                                                                                                                                                                                                    ARP = never,
                                                                                                                                                                                                                                                                                                                                                                    AJP = never,
                                                                                                                                                                                                                                                                                                                                                                    ANP = never,
                                                                                                                                                                                                                                                                                                                                                                    BRP = never,
                                                                                                                                                                                                                                                                                                                                                                    BJP = never,
                                                                                                                                                                                                                                                                                                                                                                    BNP = never,
                                                                                                                                                                                                                                                                                                                                                                    CRP = never,
                                                                                                                                                                                                                                                                                                                                                                    CJP = never,
                                                                                                                                                                                                                                                                                                                                                                    CNP = never,
                                                                                                                                                                                                                                                                                                                                                                    RRP = never,
                                                                                                                                                                                                                                                                                                                                                                    RJP = never,
                                                                                                                                                                                                                                                                                                                                                                    RNP = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TR,
                                                                                                                                                                                                                                                                                                                                                                        u: UR,
                                                                                                                                                                                                                                                                                                                                                                        v: VR,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SR[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ARD
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                    failFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TJ,
                                                                                                                                                                                                                                                                                                                                                                        u: UJ,
                                                                                                                                                                                                                                                                                                                                                                        v: VJ,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SJ[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ARF
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ARF>,
                                                                                                                                                                                                                                                                                                                                                                    progressFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TN,
                                                                                                                                                                                                                                                                                                                                                                        u: UN,
                                                                                                                                                                                                                                                                                                                                                                        v: VN,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SN[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ANP
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                    ARD
                                                                                                                                                                                                                                                                                                                                                                    | ARF
                                                                                                                                                                                                                                                                                                                                                                    | ARP,
                                                                                                                                                                                                                                                                                                                                                                    AJD | AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                    AND | ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                    BRD | BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                    BJD | BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                    BND | BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                    CRD | CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                    CJD | CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                    CND | CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                    RRD | RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                    RJD | RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                    RND | RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                                >;
                                                                                                                                                                                                                                                                                                                                                                then<
                                                                                                                                                                                                                                                                                                                                                                    ARF = never,
                                                                                                                                                                                                                                                                                                                                                                    AJF = never,
                                                                                                                                                                                                                                                                                                                                                                    ANF = never,
                                                                                                                                                                                                                                                                                                                                                                    BRF = never,
                                                                                                                                                                                                                                                                                                                                                                    BJF = never,
                                                                                                                                                                                                                                                                                                                                                                    BNF = never,
                                                                                                                                                                                                                                                                                                                                                                    CRF = never,
                                                                                                                                                                                                                                                                                                                                                                    CJF = never,
                                                                                                                                                                                                                                                                                                                                                                    CNF = never,
                                                                                                                                                                                                                                                                                                                                                                    RRF = never,
                                                                                                                                                                                                                                                                                                                                                                    RJF = never,
                                                                                                                                                                                                                                                                                                                                                                    RNF = never,
                                                                                                                                                                                                                                                                                                                                                                    ARP = never,
                                                                                                                                                                                                                                                                                                                                                                    AJP = never,
                                                                                                                                                                                                                                                                                                                                                                    ANP = never,
                                                                                                                                                                                                                                                                                                                                                                    BRP = never,
                                                                                                                                                                                                                                                                                                                                                                    BJP = never,
                                                                                                                                                                                                                                                                                                                                                                    BNP = never,
                                                                                                                                                                                                                                                                                                                                                                    CRP = never,
                                                                                                                                                                                                                                                                                                                                                                    CJP = never,
                                                                                                                                                                                                                                                                                                                                                                    CNP = never,
                                                                                                                                                                                                                                                                                                                                                                    RRP = never,
                                                                                                                                                                                                                                                                                                                                                                    RJP = never,
                                                                                                                                                                                                                                                                                                                                                                    RNP = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    doneFilter: null,
                                                                                                                                                                                                                                                                                                                                                                    failFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TJ,
                                                                                                                                                                                                                                                                                                                                                                        u: UJ,
                                                                                                                                                                                                                                                                                                                                                                        v: VJ,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SJ[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ARF
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ARF>,
                                                                                                                                                                                                                                                                                                                                                                    progressFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TN,
                                                                                                                                                                                                                                                                                                                                                                        u: UN,
                                                                                                                                                                                                                                                                                                                                                                        v: VN,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SN[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ANP
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                    ARF
                                                                                                                                                                                                                                                                                                                                                                    | ARP,
                                                                                                                                                                                                                                                                                                                                                                    AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                    ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                    BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                    BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                    BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                    CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                    CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                    CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                    RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                    RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                    RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                                >;
                                                                                                                                                                                                                                                                                                                                                                then<
                                                                                                                                                                                                                                                                                                                                                                    ARD = never,
                                                                                                                                                                                                                                                                                                                                                                    AJD = never,
                                                                                                                                                                                                                                                                                                                                                                    AND = never,
                                                                                                                                                                                                                                                                                                                                                                    BRD = never,
                                                                                                                                                                                                                                                                                                                                                                    BJD = never,
                                                                                                                                                                                                                                                                                                                                                                    BND = never,
                                                                                                                                                                                                                                                                                                                                                                    CRD = never,
                                                                                                                                                                                                                                                                                                                                                                    CJD = never,
                                                                                                                                                                                                                                                                                                                                                                    CND = never,
                                                                                                                                                                                                                                                                                                                                                                    RRD = never,
                                                                                                                                                                                                                                                                                                                                                                    RJD = never,
                                                                                                                                                                                                                                                                                                                                                                    RND = never,
                                                                                                                                                                                                                                                                                                                                                                    ARP = never,
                                                                                                                                                                                                                                                                                                                                                                    AJP = never,
                                                                                                                                                                                                                                                                                                                                                                    ANP = never,
                                                                                                                                                                                                                                                                                                                                                                    BRP = never,
                                                                                                                                                                                                                                                                                                                                                                    BJP = never,
                                                                                                                                                                                                                                                                                                                                                                    BNP = never,
                                                                                                                                                                                                                                                                                                                                                                    CRP = never,
                                                                                                                                                                                                                                                                                                                                                                    CJP = never,
                                                                                                                                                                                                                                                                                                                                                                    CNP = never,
                                                                                                                                                                                                                                                                                                                                                                    RRP = never,
                                                                                                                                                                                                                                                                                                                                                                    RJP = never,
                                                                                                                                                                                                                                                                                                                                                                    RNP = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TR,
                                                                                                                                                                                                                                                                                                                                                                        u: UR,
                                                                                                                                                                                                                                                                                                                                                                        v: VR,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SR[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ARD
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                    failFilter: null,
                                                                                                                                                                                                                                                                                                                                                                    progressFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TN,
                                                                                                                                                                                                                                                                                                                                                                        u: UN,
                                                                                                                                                                                                                                                                                                                                                                        v: VN,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SN[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ANP
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                    ARD
                                                                                                                                                                                                                                                                                                                                                                    | ARP,
                                                                                                                                                                                                                                                                                                                                                                    AJD | AJP,
                                                                                                                                                                                                                                                                                                                                                                    AND | ANP,
                                                                                                                                                                                                                                                                                                                                                                    BRD | BRP,
                                                                                                                                                                                                                                                                                                                                                                    BJD | BJP,
                                                                                                                                                                                                                                                                                                                                                                    BND | BNP,
                                                                                                                                                                                                                                                                                                                                                                    CRD | CRP,
                                                                                                                                                                                                                                                                                                                                                                    CJD | CJP,
                                                                                                                                                                                                                                                                                                                                                                    CND | CNP,
                                                                                                                                                                                                                                                                                                                                                                    RRD | RRP,
                                                                                                                                                                                                                                                                                                                                                                    RJD | RJP,
                                                                                                                                                                                                                                                                                                                                                                    RND | RNP,
                                                                                                                                                                                                                                                                                                                                                                >;
                                                                                                                                                                                                                                                                                                                                                                then<
                                                                                                                                                                                                                                                                                                                                                                    ARP = never,
                                                                                                                                                                                                                                                                                                                                                                    AJP = never,
                                                                                                                                                                                                                                                                                                                                                                    ANP = never,
                                                                                                                                                                                                                                                                                                                                                                    BRP = never,
                                                                                                                                                                                                                                                                                                                                                                    BJP = never,
                                                                                                                                                                                                                                                                                                                                                                    BNP = never,
                                                                                                                                                                                                                                                                                                                                                                    CRP = never,
                                                                                                                                                                                                                                                                                                                                                                    CJP = never,
                                                                                                                                                                                                                                                                                                                                                                    CNP = never,
                                                                                                                                                                                                                                                                                                                                                                    RRP = never,
                                                                                                                                                                                                                                                                                                                                                                    RJP = never,
                                                                                                                                                                                                                                                                                                                                                                    RNP = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    doneFilter: null,
                                                                                                                                                                                                                                                                                                                                                                    failFilter: null,
                                                                                                                                                                                                                                                                                                                                                                    progressFilter?: (
                                                                                                                                                                                                                                                                                                                                                                        t: TN,
                                                                                                                                                                                                                                                                                                                                                                        u: UN,
                                                                                                                                                                                                                                                                                                                                                                        v: VN,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SN[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ANP
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ANP>,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>;
                                                                                                                                                                                                                                                                                                                                                                then<
                                                                                                                                                                                                                                                                                                                                                                    ARD = never,
                                                                                                                                                                                                                                                                                                                                                                    AJD = never,
                                                                                                                                                                                                                                                                                                                                                                    AND = never,
                                                                                                                                                                                                                                                                                                                                                                    BRD = never,
                                                                                                                                                                                                                                                                                                                                                                    BJD = never,
                                                                                                                                                                                                                                                                                                                                                                    BND = never,
                                                                                                                                                                                                                                                                                                                                                                    CRD = never,
                                                                                                                                                                                                                                                                                                                                                                    CJD = never,
                                                                                                                                                                                                                                                                                                                                                                    CND = never,
                                                                                                                                                                                                                                                                                                                                                                    RRD = never,
                                                                                                                                                                                                                                                                                                                                                                    RJD = never,
                                                                                                                                                                                                                                                                                                                                                                    RND = never,
                                                                                                                                                                                                                                                                                                                                                                    ARF = never,
                                                                                                                                                                                                                                                                                                                                                                    AJF = never,
                                                                                                                                                                                                                                                                                                                                                                    ANF = never,
                                                                                                                                                                                                                                                                                                                                                                    BRF = never,
                                                                                                                                                                                                                                                                                                                                                                    BJF = never,
                                                                                                                                                                                                                                                                                                                                                                    BNF = never,
                                                                                                                                                                                                                                                                                                                                                                    CRF = never,
                                                                                                                                                                                                                                                                                                                                                                    CJF = never,
                                                                                                                                                                                                                                                                                                                                                                    CNF = never,
                                                                                                                                                                                                                                                                                                                                                                    RRF = never,
                                                                                                                                                                                                                                                                                                                                                                    RJF = never,
                                                                                                                                                                                                                                                                                                                                                                    RNF = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TR,
                                                                                                                                                                                                                                                                                                                                                                        u: UR,
                                                                                                                                                                                                                                                                                                                                                                        v: VR,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SR[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ARD
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                    failFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TJ,
                                                                                                                                                                                                                                                                                                                                                                        u: UJ,
                                                                                                                                                                                                                                                                                                                                                                        v: VJ,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SJ[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ARF
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ARF>,
                                                                                                                                                                                                                                                                                                                                                                    progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                    ARD
                                                                                                                                                                                                                                                                                                                                                                    | ARF,
                                                                                                                                                                                                                                                                                                                                                                    AJD | AJF,
                                                                                                                                                                                                                                                                                                                                                                    AND | ANF,
                                                                                                                                                                                                                                                                                                                                                                    BRD | BRF,
                                                                                                                                                                                                                                                                                                                                                                    BJD | BJF,
                                                                                                                                                                                                                                                                                                                                                                    BND | BNF,
                                                                                                                                                                                                                                                                                                                                                                    CRD | CRF,
                                                                                                                                                                                                                                                                                                                                                                    CJD | CJF,
                                                                                                                                                                                                                                                                                                                                                                    CND | CNF,
                                                                                                                                                                                                                                                                                                                                                                    RRD | RRF,
                                                                                                                                                                                                                                                                                                                                                                    RJD | RJF,
                                                                                                                                                                                                                                                                                                                                                                    RND | RNF,
                                                                                                                                                                                                                                                                                                                                                                >;
                                                                                                                                                                                                                                                                                                                                                                then<
                                                                                                                                                                                                                                                                                                                                                                    ARF = never,
                                                                                                                                                                                                                                                                                                                                                                    AJF = never,
                                                                                                                                                                                                                                                                                                                                                                    ANF = never,
                                                                                                                                                                                                                                                                                                                                                                    BRF = never,
                                                                                                                                                                                                                                                                                                                                                                    BJF = never,
                                                                                                                                                                                                                                                                                                                                                                    BNF = never,
                                                                                                                                                                                                                                                                                                                                                                    CRF = never,
                                                                                                                                                                                                                                                                                                                                                                    CJF = never,
                                                                                                                                                                                                                                                                                                                                                                    CNF = never,
                                                                                                                                                                                                                                                                                                                                                                    RRF = never,
                                                                                                                                                                                                                                                                                                                                                                    RJF = never,
                                                                                                                                                                                                                                                                                                                                                                    RNF = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    doneFilter: null,
                                                                                                                                                                                                                                                                                                                                                                    failFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TJ,
                                                                                                                                                                                                                                                                                                                                                                        u: UJ,
                                                                                                                                                                                                                                                                                                                                                                        v: VJ,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SJ[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ARF
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ARF>,
                                                                                                                                                                                                                                                                                                                                                                    progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>;
                                                                                                                                                                                                                                                                                                                                                                then<
                                                                                                                                                                                                                                                                                                                                                                    ARD = never,
                                                                                                                                                                                                                                                                                                                                                                    AJD = never,
                                                                                                                                                                                                                                                                                                                                                                    AND = never,
                                                                                                                                                                                                                                                                                                                                                                    BRD = never,
                                                                                                                                                                                                                                                                                                                                                                    BJD = never,
                                                                                                                                                                                                                                                                                                                                                                    BND = never,
                                                                                                                                                                                                                                                                                                                                                                    CRD = never,
                                                                                                                                                                                                                                                                                                                                                                    CJD = never,
                                                                                                                                                                                                                                                                                                                                                                    CND = never,
                                                                                                                                                                                                                                                                                                                                                                    RRD = never,
                                                                                                                                                                                                                                                                                                                                                                    RJD = never,
                                                                                                                                                                                                                                                                                                                                                                    RND = never,
                                                                                                                                                                                                                                                                                                                                                                >(
                                                                                                                                                                                                                                                                                                                                                                    doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                        t: TR,
                                                                                                                                                                                                                                                                                                                                                                        u: UR,
                                                                                                                                                                                                                                                                                                                                                                        v: VR,
                                                                                                                                                                                                                                                                                                                                                                        ...s: SR[],
                                                                                                                                                                                                                                                                                                                                                                    ) =>
                                                                                                                                                                                                                                                                                                                                                                        | ARD
                                                                                                                                                                                                                                                                                                                                                                        | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                        | Thenable<ARD>,
                                                                                                                                                                                                                                                                                                                                                                    failFilter?: null,
                                                                                                                                                                                                                                                                                                                                                                    progressFilter?: null,
                                                                                                                                                                                                                                                                                                                                                                ): PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                            • TR
                                                                                                                                                                                                                                                                                                                                                            • TJ
                                                                                                                                                                                                                                                                                                                                                            • TN
                                                                                                                                                                                                                                                                                                                                                            • UR
                                                                                                                                                                                                                                                                                                                                                            • UJ
                                                                                                                                                                                                                                                                                                                                                            • UN
                                                                                                                                                                                                                                                                                                                                                            • VR
                                                                                                                                                                                                                                                                                                                                                            • VJ
                                                                                                                                                                                                                                                                                                                                                            • VN
                                                                                                                                                                                                                                                                                                                                                            • SR
                                                                                                                                                                                                                                                                                                                                                            • SJ
                                                                                                                                                                                                                                                                                                                                                            • SN

                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                            always +catch +done +fail +pipe +progress +promise +state +then +

                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                            • Add handlers to be called when the Deferred object is either resolved or rejected.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.always/">https://api.jquery.com/deferred.always/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.6

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Since the jQuery.get() method returns a jqXHR object, which is derived from a Deferred object, we can attach a callback for both success and error using the deferred.always() method.

                                                                                                                                                                                                                                                                                                                                                              $.get( "test.php" ).always(function() {
                                                                                                                                                                                                                                                                                                                                                              alert( "$.get completed with success or error callback arguments" );
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Add handlers to be called when the Deferred object is rejected.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARF = never
                                                                                                                                                                                                                                                                                                                                                              • AJF = never
                                                                                                                                                                                                                                                                                                                                                              • ANF = never
                                                                                                                                                                                                                                                                                                                                                              • BRF = never
                                                                                                                                                                                                                                                                                                                                                              • BJF = never
                                                                                                                                                                                                                                                                                                                                                              • BNF = never
                                                                                                                                                                                                                                                                                                                                                              • CRF = never
                                                                                                                                                                                                                                                                                                                                                              • CJF = never
                                                                                                                                                                                                                                                                                                                                                              • CNF = never
                                                                                                                                                                                                                                                                                                                                                              • RRF = never
                                                                                                                                                                                                                                                                                                                                                              • RJF = never
                                                                                                                                                                                                                                                                                                                                                              • RNF = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              • OptionalfailFilter:
                                                                                                                                                                                                                                                                                                                                                                    | null
                                                                                                                                                                                                                                                                                                                                                                    | (
                                                                                                                                                                                                                                                                                                                                                                        (
                                                                                                                                                                                                                                                                                                                                                                            t: TJ,
                                                                                                                                                                                                                                                                                                                                                                            u: UJ,
                                                                                                                                                                                                                                                                                                                                                                            v: VJ,
                                                                                                                                                                                                                                                                                                                                                                            ...s: SJ[],
                                                                                                                                                                                                                                                                                                                                                                        ) =>
                                                                                                                                                                                                                                                                                                                                                                            | ARF
                                                                                                                                                                                                                                                                                                                                                                            | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                            | Thenable<ARF>
                                                                                                                                                                                                                                                                                                                                                                    )

                                                                                                                                                                                                                                                                                                                                                                A function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.catch/">https://api.jquery.com/deferred.catch/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              3.0

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can rejection handlers using the .catch method.

                                                                                                                                                                                                                                                                                                                                                              $.get( "test.php" )
                                                                                                                                                                                                                                                                                                                                                              .then( function() {
                                                                                                                                                                                                                                                                                                                                                              alert( "$.get succeeded" );
                                                                                                                                                                                                                                                                                                                                                              } )
                                                                                                                                                                                                                                                                                                                                                              .catch( function() {
                                                                                                                                                                                                                                                                                                                                                              alert( "$.get failed!" );
                                                                                                                                                                                                                                                                                                                                                              } );
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Add handlers to be called when the Deferred object is resolved.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.done/">https://api.jquery.com/deferred.done/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.5

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach a success callback using the .done() method. +```javascript +$.get( "test.php" ).done(function() { +alert( "$.get succeeded" ); +}); +``` +@example ​ ````Resolve a Deferred object when the user clicks a button, triggering a number of callback functions:

                                                                                                                                                                                                                                                                                                                                                              <!doctype html>
                                                                                                                                                                                                                                                                                                                                                              <html lang="en">
                                                                                                                                                                                                                                                                                                                                                              <head>
                                                                                                                                                                                                                                                                                                                                                              <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                              <title>deferred.done demo</title>
                                                                                                                                                                                                                                                                                                                                                              <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                              </head>
                                                                                                                                                                                                                                                                                                                                                              <body>
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              <button>Go</button>
                                                                                                                                                                                                                                                                                                                                                              <p>Ready...</p>
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              <script>
                                                                                                                                                                                                                                                                                                                                                              // 3 functions to call when the Deferred object is resolved
                                                                                                                                                                                                                                                                                                                                                              function fn1() {
                                                                                                                                                                                                                                                                                                                                                              $( "p" ).append( " 1 " );
                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                              function fn2() {
                                                                                                                                                                                                                                                                                                                                                              $( "p" ).append( " 2 " );
                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                              function fn3( n ) {
                                                                                                                                                                                                                                                                                                                                                              $( "p" ).append( n + " 3 " + n );
                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              // Create a deferred object
                                                                                                                                                                                                                                                                                                                                                              var dfd = $.Deferred();
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              // Add handlers to be called when dfd is resolved
                                                                                                                                                                                                                                                                                                                                                              dfd
                                                                                                                                                                                                                                                                                                                                                              // .done() can take any number of functions or arrays of functions
                                                                                                                                                                                                                                                                                                                                                              .done( [ fn1, fn2 ], fn3, [ fn2, fn1 ] )
                                                                                                                                                                                                                                                                                                                                                              // We can chain done methods, too
                                                                                                                                                                                                                                                                                                                                                              .done(function( n ) {
                                                                                                                                                                                                                                                                                                                                                              $( "p" ).append( n + " we're done." );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              // Resolve the Deferred object when the button is clicked
                                                                                                                                                                                                                                                                                                                                                              $( "button" ).on( "click", function() {
                                                                                                                                                                                                                                                                                                                                                              dfd.resolve( "and" );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              </script>
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              </body>
                                                                                                                                                                                                                                                                                                                                                              </html>
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Add handlers to be called when the Deferred object is rejected.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.fail/">https://api.jquery.com/deferred.fail/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.5

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred, you can attach a success and failure callback using the deferred.done() and deferred.fail() methods.

                                                                                                                                                                                                                                                                                                                                                              $.get( "test.php" )
                                                                                                                                                                                                                                                                                                                                                              .done(function() {
                                                                                                                                                                                                                                                                                                                                                              alert( "$.get succeeded" );
                                                                                                                                                                                                                                                                                                                                                              })
                                                                                                                                                                                                                                                                                                                                                              .fail(function() {
                                                                                                                                                                                                                                                                                                                                                              alert( "$.get failed!" );
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARD = never
                                                                                                                                                                                                                                                                                                                                                              • AJD = never
                                                                                                                                                                                                                                                                                                                                                              • AND = never
                                                                                                                                                                                                                                                                                                                                                              • BRD = never
                                                                                                                                                                                                                                                                                                                                                              • BJD = never
                                                                                                                                                                                                                                                                                                                                                              • BND = never
                                                                                                                                                                                                                                                                                                                                                              • CRD = never
                                                                                                                                                                                                                                                                                                                                                              • CJD = never
                                                                                                                                                                                                                                                                                                                                                              • CND = never
                                                                                                                                                                                                                                                                                                                                                              • RRD = never
                                                                                                                                                                                                                                                                                                                                                              • RJD = never
                                                                                                                                                                                                                                                                                                                                                              • RND = never
                                                                                                                                                                                                                                                                                                                                                              • ARF = never
                                                                                                                                                                                                                                                                                                                                                              • AJF = never
                                                                                                                                                                                                                                                                                                                                                              • ANF = never
                                                                                                                                                                                                                                                                                                                                                              • BRF = never
                                                                                                                                                                                                                                                                                                                                                              • BJF = never
                                                                                                                                                                                                                                                                                                                                                              • BNF = never
                                                                                                                                                                                                                                                                                                                                                              • CRF = never
                                                                                                                                                                                                                                                                                                                                                              • CJF = never
                                                                                                                                                                                                                                                                                                                                                              • CNF = never
                                                                                                                                                                                                                                                                                                                                                              • RRF = never
                                                                                                                                                                                                                                                                                                                                                              • RJF = never
                                                                                                                                                                                                                                                                                                                                                              • RNF = never
                                                                                                                                                                                                                                                                                                                                                              • ARP = never
                                                                                                                                                                                                                                                                                                                                                              • AJP = never
                                                                                                                                                                                                                                                                                                                                                              • ANP = never
                                                                                                                                                                                                                                                                                                                                                              • BRP = never
                                                                                                                                                                                                                                                                                                                                                              • BJP = never
                                                                                                                                                                                                                                                                                                                                                              • BNP = never
                                                                                                                                                                                                                                                                                                                                                              • CRP = never
                                                                                                                                                                                                                                                                                                                                                              • CJP = never
                                                                                                                                                                                                                                                                                                                                                              • CNP = never
                                                                                                                                                                                                                                                                                                                                                              • RRP = never
                                                                                                                                                                                                                                                                                                                                                              • RJP = never
                                                                                                                                                                                                                                                                                                                                                              • RNP = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARD
                                                                                                                                                                                                                                                                                                                                                                  | ARF
                                                                                                                                                                                                                                                                                                                                                                  | ARP,
                                                                                                                                                                                                                                                                                                                                                                  AJD | AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                  AND | ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                  BRD | BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                  BJD | BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                  BND | BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                  CRD | CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                  CJD | CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                  CND | CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                  RRD | RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                  RJD | RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                  RND | RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                              >

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.6

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.7

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Filter resolve value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +alert( "Value is ( 2*5 = ) 10: " + value ); +}); +``` +@example ​ ````Filter reject value:

                                                                                                                                                                                                                                                                                                                                                              var defer = $.Deferred(),
                                                                                                                                                                                                                                                                                                                                                              filtered = defer.pipe( null, function( value ) {
                                                                                                                                                                                                                                                                                                                                                              return value * 3;
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              defer.reject( 6 );
                                                                                                                                                                                                                                                                                                                                                              filtered.fail(function( value ) {
                                                                                                                                                                                                                                                                                                                                                              alert( "Value is ( 3*6 = ) 18: " + value );
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                              var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                              chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARF = never
                                                                                                                                                                                                                                                                                                                                                              • AJF = never
                                                                                                                                                                                                                                                                                                                                                              • ANF = never
                                                                                                                                                                                                                                                                                                                                                              • BRF = never
                                                                                                                                                                                                                                                                                                                                                              • BJF = never
                                                                                                                                                                                                                                                                                                                                                              • BNF = never
                                                                                                                                                                                                                                                                                                                                                              • CRF = never
                                                                                                                                                                                                                                                                                                                                                              • CJF = never
                                                                                                                                                                                                                                                                                                                                                              • CNF = never
                                                                                                                                                                                                                                                                                                                                                              • RRF = never
                                                                                                                                                                                                                                                                                                                                                              • RJF = never
                                                                                                                                                                                                                                                                                                                                                              • RNF = never
                                                                                                                                                                                                                                                                                                                                                              • ARP = never
                                                                                                                                                                                                                                                                                                                                                              • AJP = never
                                                                                                                                                                                                                                                                                                                                                              • ANP = never
                                                                                                                                                                                                                                                                                                                                                              • BRP = never
                                                                                                                                                                                                                                                                                                                                                              • BJP = never
                                                                                                                                                                                                                                                                                                                                                              • BNP = never
                                                                                                                                                                                                                                                                                                                                                              • CRP = never
                                                                                                                                                                                                                                                                                                                                                              • CJP = never
                                                                                                                                                                                                                                                                                                                                                              • CNP = never
                                                                                                                                                                                                                                                                                                                                                              • RRP = never
                                                                                                                                                                                                                                                                                                                                                              • RJP = never
                                                                                                                                                                                                                                                                                                                                                              • RNP = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARF
                                                                                                                                                                                                                                                                                                                                                                  | ARP,
                                                                                                                                                                                                                                                                                                                                                                  AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                  ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                  BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                  BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                  BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                  CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                  CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                  CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                  RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                  RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                  RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                              >

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.6

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.7

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                              var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                              chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARD = never
                                                                                                                                                                                                                                                                                                                                                              • AJD = never
                                                                                                                                                                                                                                                                                                                                                              • AND = never
                                                                                                                                                                                                                                                                                                                                                              • BRD = never
                                                                                                                                                                                                                                                                                                                                                              • BJD = never
                                                                                                                                                                                                                                                                                                                                                              • BND = never
                                                                                                                                                                                                                                                                                                                                                              • CRD = never
                                                                                                                                                                                                                                                                                                                                                              • CJD = never
                                                                                                                                                                                                                                                                                                                                                              • CND = never
                                                                                                                                                                                                                                                                                                                                                              • RRD = never
                                                                                                                                                                                                                                                                                                                                                              • RJD = never
                                                                                                                                                                                                                                                                                                                                                              • RND = never
                                                                                                                                                                                                                                                                                                                                                              • ARP = never
                                                                                                                                                                                                                                                                                                                                                              • AJP = never
                                                                                                                                                                                                                                                                                                                                                              • ANP = never
                                                                                                                                                                                                                                                                                                                                                              • BRP = never
                                                                                                                                                                                                                                                                                                                                                              • BJP = never
                                                                                                                                                                                                                                                                                                                                                              • BNP = never
                                                                                                                                                                                                                                                                                                                                                              • CRP = never
                                                                                                                                                                                                                                                                                                                                                              • CJP = never
                                                                                                                                                                                                                                                                                                                                                              • CNP = never
                                                                                                                                                                                                                                                                                                                                                              • RRP = never
                                                                                                                                                                                                                                                                                                                                                              • RJP = never
                                                                                                                                                                                                                                                                                                                                                              • RNP = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARD
                                                                                                                                                                                                                                                                                                                                                                  | ARP,
                                                                                                                                                                                                                                                                                                                                                                  AJD | AJP,
                                                                                                                                                                                                                                                                                                                                                                  AND | ANP,
                                                                                                                                                                                                                                                                                                                                                                  BRD | BRP,
                                                                                                                                                                                                                                                                                                                                                                  BJD | BJP,
                                                                                                                                                                                                                                                                                                                                                                  BND | BNP,
                                                                                                                                                                                                                                                                                                                                                                  CRD | CRP,
                                                                                                                                                                                                                                                                                                                                                                  CJD | CJP,
                                                                                                                                                                                                                                                                                                                                                                  CND | CNP,
                                                                                                                                                                                                                                                                                                                                                                  RRD | RRP,
                                                                                                                                                                                                                                                                                                                                                                  RJD | RJP,
                                                                                                                                                                                                                                                                                                                                                                  RND | RNP,
                                                                                                                                                                                                                                                                                                                                                              >

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.6

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.7

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Filter resolve value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +alert( "Value is ( 2*5 = ) 10: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                              var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                              chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARP = never
                                                                                                                                                                                                                                                                                                                                                              • AJP = never
                                                                                                                                                                                                                                                                                                                                                              • ANP = never
                                                                                                                                                                                                                                                                                                                                                              • BRP = never
                                                                                                                                                                                                                                                                                                                                                              • BJP = never
                                                                                                                                                                                                                                                                                                                                                              • BNP = never
                                                                                                                                                                                                                                                                                                                                                              • CRP = never
                                                                                                                                                                                                                                                                                                                                                              • CJP = never
                                                                                                                                                                                                                                                                                                                                                              • CNP = never
                                                                                                                                                                                                                                                                                                                                                              • RRP = never
                                                                                                                                                                                                                                                                                                                                                              • RJP = never
                                                                                                                                                                                                                                                                                                                                                              • RNP = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              • doneFilter: null

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                              • failFilter: null

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                              • OptionalprogressFilter: (
                                                                                                                                                                                                                                                                                                                                                                    t: TN,
                                                                                                                                                                                                                                                                                                                                                                    u: UN,
                                                                                                                                                                                                                                                                                                                                                                    v: VN,
                                                                                                                                                                                                                                                                                                                                                                    ...s: SN[],
                                                                                                                                                                                                                                                                                                                                                                ) =>
                                                                                                                                                                                                                                                                                                                                                                    | ANP
                                                                                                                                                                                                                                                                                                                                                                    | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                    | Thenable<ANP>

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.6

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.7

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                              var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                              chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARD = never
                                                                                                                                                                                                                                                                                                                                                              • AJD = never
                                                                                                                                                                                                                                                                                                                                                              • AND = never
                                                                                                                                                                                                                                                                                                                                                              • BRD = never
                                                                                                                                                                                                                                                                                                                                                              • BJD = never
                                                                                                                                                                                                                                                                                                                                                              • BND = never
                                                                                                                                                                                                                                                                                                                                                              • CRD = never
                                                                                                                                                                                                                                                                                                                                                              • CJD = never
                                                                                                                                                                                                                                                                                                                                                              • CND = never
                                                                                                                                                                                                                                                                                                                                                              • RRD = never
                                                                                                                                                                                                                                                                                                                                                              • RJD = never
                                                                                                                                                                                                                                                                                                                                                              • RND = never
                                                                                                                                                                                                                                                                                                                                                              • ARF = never
                                                                                                                                                                                                                                                                                                                                                              • AJF = never
                                                                                                                                                                                                                                                                                                                                                              • ANF = never
                                                                                                                                                                                                                                                                                                                                                              • BRF = never
                                                                                                                                                                                                                                                                                                                                                              • BJF = never
                                                                                                                                                                                                                                                                                                                                                              • BNF = never
                                                                                                                                                                                                                                                                                                                                                              • CRF = never
                                                                                                                                                                                                                                                                                                                                                              • CJF = never
                                                                                                                                                                                                                                                                                                                                                              • CNF = never
                                                                                                                                                                                                                                                                                                                                                              • RRF = never
                                                                                                                                                                                                                                                                                                                                                              • RJF = never
                                                                                                                                                                                                                                                                                                                                                              • RNF = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARD
                                                                                                                                                                                                                                                                                                                                                                  | ARF,
                                                                                                                                                                                                                                                                                                                                                                  AJD | AJF,
                                                                                                                                                                                                                                                                                                                                                                  AND | ANF,
                                                                                                                                                                                                                                                                                                                                                                  BRD | BRF,
                                                                                                                                                                                                                                                                                                                                                                  BJD | BJF,
                                                                                                                                                                                                                                                                                                                                                                  BND | BNF,
                                                                                                                                                                                                                                                                                                                                                                  CRD | CRF,
                                                                                                                                                                                                                                                                                                                                                                  CJD | CJF,
                                                                                                                                                                                                                                                                                                                                                                  CND | CNF,
                                                                                                                                                                                                                                                                                                                                                                  RRD | RRF,
                                                                                                                                                                                                                                                                                                                                                                  RJD | RJF,
                                                                                                                                                                                                                                                                                                                                                                  RND | RNF,
                                                                                                                                                                                                                                                                                                                                                              >

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.6

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.7

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Filter resolve value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +alert( "Value is ( 2*5 = ) 10: " + value ); +}); +``` +@example ​ ````Filter reject value:

                                                                                                                                                                                                                                                                                                                                                              var defer = $.Deferred(),
                                                                                                                                                                                                                                                                                                                                                              filtered = defer.pipe( null, function( value ) {
                                                                                                                                                                                                                                                                                                                                                              return value * 3;
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              defer.reject( 6 );
                                                                                                                                                                                                                                                                                                                                                              filtered.fail(function( value ) {
                                                                                                                                                                                                                                                                                                                                                              alert( "Value is ( 3*6 = ) 18: " + value );
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                              var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                              chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARF = never
                                                                                                                                                                                                                                                                                                                                                              • AJF = never
                                                                                                                                                                                                                                                                                                                                                              • ANF = never
                                                                                                                                                                                                                                                                                                                                                              • BRF = never
                                                                                                                                                                                                                                                                                                                                                              • BJF = never
                                                                                                                                                                                                                                                                                                                                                              • BNF = never
                                                                                                                                                                                                                                                                                                                                                              • CRF = never
                                                                                                                                                                                                                                                                                                                                                              • CJF = never
                                                                                                                                                                                                                                                                                                                                                              • CNF = never
                                                                                                                                                                                                                                                                                                                                                              • RRF = never
                                                                                                                                                                                                                                                                                                                                                              • RJF = never
                                                                                                                                                                                                                                                                                                                                                              • RNF = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              • doneFilter: null

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                              • failFilter: (
                                                                                                                                                                                                                                                                                                                                                                    t: TJ,
                                                                                                                                                                                                                                                                                                                                                                    u: UJ,
                                                                                                                                                                                                                                                                                                                                                                    v: VJ,
                                                                                                                                                                                                                                                                                                                                                                    ...s: SJ[],
                                                                                                                                                                                                                                                                                                                                                                ) =>
                                                                                                                                                                                                                                                                                                                                                                    | AJF
                                                                                                                                                                                                                                                                                                                                                                    | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                    | Thenable<AJF>

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                              • OptionalprogressFilter: null

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.6

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.7

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                              var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                              chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Utility method to filter and/or chain Deferreds.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARD = never
                                                                                                                                                                                                                                                                                                                                                              • AJD = never
                                                                                                                                                                                                                                                                                                                                                              • AND = never
                                                                                                                                                                                                                                                                                                                                                              • BRD = never
                                                                                                                                                                                                                                                                                                                                                              • BJD = never
                                                                                                                                                                                                                                                                                                                                                              • BND = never
                                                                                                                                                                                                                                                                                                                                                              • CRD = never
                                                                                                                                                                                                                                                                                                                                                              • CJD = never
                                                                                                                                                                                                                                                                                                                                                              • CND = never
                                                                                                                                                                                                                                                                                                                                                              • RRD = never
                                                                                                                                                                                                                                                                                                                                                              • RJD = never
                                                                                                                                                                                                                                                                                                                                                              • RND = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              • doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                    t: TR,
                                                                                                                                                                                                                                                                                                                                                                    u: UR,
                                                                                                                                                                                                                                                                                                                                                                    v: VR,
                                                                                                                                                                                                                                                                                                                                                                    ...s: SR[],
                                                                                                                                                                                                                                                                                                                                                                ) =>
                                                                                                                                                                                                                                                                                                                                                                    | ARD
                                                                                                                                                                                                                                                                                                                                                                    | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                    | Thenable<ARD>

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                              • OptionalfailFilter: null

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                              • OptionalprogressFilter: null

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.pipe/">https://api.jquery.com/deferred.pipe/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.6

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.7

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              ​ Deprecated since 1.8. Use <a href="#then" class="tsd-kind-method">then</a>.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Cause: The .pipe() method on a jQuery.Deferred object was deprecated as of jQuery 1.8, when the .then() method was changed to perform the same function.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Solution: In most cases it is sufficient to change all occurrences of .pipe() to .then(). Ensure that you aren't relying on context/state propagation (e.g., using this) or synchronous callback invocation, which were dropped from .then() for Promises/A+ interoperability as of jQuery 3.0.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Filter resolve value: +```javascript +var defer = $.Deferred(), +filtered = defer.pipe(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +alert( "Value is ( 2*5 = ) 10: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                              var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                              chained = request.pipe(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Add handlers to be called when the Deferred object generates progress notifications.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              • progressCallback: TypeOrArray<CallbackBase<TN, UN, VN, SN>>

                                                                                                                                                                                                                                                                                                                                                                A function, or array of functions, to be called when the Deferred generates progress notifications.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                              • ...progressCallbacks: TypeOrArray<CallbackBase<TN, UN, VN, SN>>[]

                                                                                                                                                                                                                                                                                                                                                                Optional additional functions, or arrays of functions, to be called when the Deferred generates +progress notifications.

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.progress/">https://api.jquery.com/deferred.progress/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.7

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                            • Return a Deferred's Promise object.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • TTarget extends object

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              • target: TTarget

                                                                                                                                                                                                                                                                                                                                                                Object onto which the promise methods have to be attached

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<TR, TJ, TN, UR, UJ, UN, VR, VJ, VN, SR, SJ, SN> & TTarget

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.promise/">https://api.jquery.com/deferred.promise/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.5

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Create a Deferred and set two timer-based functions to either resolve or reject the Deferred after a random interval. Whichever one fires first &quot;wins&quot; and will call one of the callbacks. The second timeout has no effect since the Deferred is already complete (in a resolved or rejected state) from the first timeout action. Also set a timer-based progress notification function, and call a progress handler that adds &quot;working...&quot; to the document body.

                                                                                                                                                                                                                                                                                                                                                              function asyncEvent() {
                                                                                                                                                                                                                                                                                                                                                              var dfd = jQuery.Deferred();
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              // Resolve after a random interval
                                                                                                                                                                                                                                                                                                                                                              setTimeout(function() {
                                                                                                                                                                                                                                                                                                                                                              dfd.resolve( "hurray" );
                                                                                                                                                                                                                                                                                                                                                              }, Math.floor( 400 + Math.random() * 2000 ) );
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              // Reject after a random interval
                                                                                                                                                                                                                                                                                                                                                              setTimeout(function() {
                                                                                                                                                                                                                                                                                                                                                              dfd.reject( "sorry" );
                                                                                                                                                                                                                                                                                                                                                              }, Math.floor( 400 + Math.random() * 2000 ) );
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              // Show a "working..." message every half-second
                                                                                                                                                                                                                                                                                                                                                              setTimeout(function working() {
                                                                                                                                                                                                                                                                                                                                                              if ( dfd.state() === "pending" ) {
                                                                                                                                                                                                                                                                                                                                                              dfd.notify( "working... " );
                                                                                                                                                                                                                                                                                                                                                              setTimeout( working, 500 );
                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                              }, 1 );
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              // Return the Promise so caller can't change the Deferred
                                                                                                                                                                                                                                                                                                                                                              return dfd.promise();
                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              // Attach a done, fail, and progress handler for the asyncEvent
                                                                                                                                                                                                                                                                                                                                                              $.when( asyncEvent() ).then(
                                                                                                                                                                                                                                                                                                                                                              function( status ) {
                                                                                                                                                                                                                                                                                                                                                              alert( status + ", things are going well" );
                                                                                                                                                                                                                                                                                                                                                              },
                                                                                                                                                                                                                                                                                                                                                              function( status ) {
                                                                                                                                                                                                                                                                                                                                                              alert( status + ", you fail this time" );
                                                                                                                                                                                                                                                                                                                                                              },
                                                                                                                                                                                                                                                                                                                                                              function( status ) {
                                                                                                                                                                                                                                                                                                                                                              $( "body" ).append( status );
                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                              );
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Return a Deferred's Promise object.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.promise/">https://api.jquery.com/deferred.promise/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.5

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Use the target argument to promote an existing object to a Promise:

                                                                                                                                                                                                                                                                                                                                                              // Existing object
                                                                                                                                                                                                                                                                                                                                                              var obj = {
                                                                                                                                                                                                                                                                                                                                                              hello: function( name ) {
                                                                                                                                                                                                                                                                                                                                                              alert( "Hello " + name );
                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                              },
                                                                                                                                                                                                                                                                                                                                                              // Create a Deferred
                                                                                                                                                                                                                                                                                                                                                              defer = $.Deferred();
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              // Set object as a promise
                                                                                                                                                                                                                                                                                                                                                              defer.promise( obj );
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              // Resolve the deferred
                                                                                                                                                                                                                                                                                                                                                              defer.resolve( "John" );
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              // Use the object as a Promise
                                                                                                                                                                                                                                                                                                                                                              obj.done(function( name ) {
                                                                                                                                                                                                                                                                                                                                                              obj.hello( name ); // Will alert "Hello John"
                                                                                                                                                                                                                                                                                                                                                              }).hello( "Karl" ); // Will alert "Hello Karl"
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Determine the current state of a Deferred object.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Returns "pending" | "resolved" | "rejected"

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.state/">https://api.jquery.com/deferred.state/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.7

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                            • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARD = never
                                                                                                                                                                                                                                                                                                                                                              • AJD = never
                                                                                                                                                                                                                                                                                                                                                              • AND = never
                                                                                                                                                                                                                                                                                                                                                              • BRD = never
                                                                                                                                                                                                                                                                                                                                                              • BJD = never
                                                                                                                                                                                                                                                                                                                                                              • BND = never
                                                                                                                                                                                                                                                                                                                                                              • CRD = never
                                                                                                                                                                                                                                                                                                                                                              • CJD = never
                                                                                                                                                                                                                                                                                                                                                              • CND = never
                                                                                                                                                                                                                                                                                                                                                              • RRD = never
                                                                                                                                                                                                                                                                                                                                                              • RJD = never
                                                                                                                                                                                                                                                                                                                                                              • RND = never
                                                                                                                                                                                                                                                                                                                                                              • ARF = never
                                                                                                                                                                                                                                                                                                                                                              • AJF = never
                                                                                                                                                                                                                                                                                                                                                              • ANF = never
                                                                                                                                                                                                                                                                                                                                                              • BRF = never
                                                                                                                                                                                                                                                                                                                                                              • BJF = never
                                                                                                                                                                                                                                                                                                                                                              • BNF = never
                                                                                                                                                                                                                                                                                                                                                              • CRF = never
                                                                                                                                                                                                                                                                                                                                                              • CJF = never
                                                                                                                                                                                                                                                                                                                                                              • CNF = never
                                                                                                                                                                                                                                                                                                                                                              • RRF = never
                                                                                                                                                                                                                                                                                                                                                              • RJF = never
                                                                                                                                                                                                                                                                                                                                                              • RNF = never
                                                                                                                                                                                                                                                                                                                                                              • ARP = never
                                                                                                                                                                                                                                                                                                                                                              • AJP = never
                                                                                                                                                                                                                                                                                                                                                              • ANP = never
                                                                                                                                                                                                                                                                                                                                                              • BRP = never
                                                                                                                                                                                                                                                                                                                                                              • BJP = never
                                                                                                                                                                                                                                                                                                                                                              • BNP = never
                                                                                                                                                                                                                                                                                                                                                              • CRP = never
                                                                                                                                                                                                                                                                                                                                                              • CJP = never
                                                                                                                                                                                                                                                                                                                                                              • CNP = never
                                                                                                                                                                                                                                                                                                                                                              • RRP = never
                                                                                                                                                                                                                                                                                                                                                              • RJP = never
                                                                                                                                                                                                                                                                                                                                                              • RNP = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARD
                                                                                                                                                                                                                                                                                                                                                                  | ARF
                                                                                                                                                                                                                                                                                                                                                                  | ARP,
                                                                                                                                                                                                                                                                                                                                                                  AJD | AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                  AND | ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                  BRD | BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                  BJD | BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                  BND | BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                  CRD | CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                  CJD | CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                  CND | CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                  RRD | RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                  RJD | RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                  RND | RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                              >

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.8

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method. +```javascript +$.get( "test.php" ).then( +function() { +alert( "$.get succeeded" ); +}, function() { +alert( "$.get failed!" ); +} +); +``` +@example ​ ````Filter the resolve value:

                                                                                                                                                                                                                                                                                                                                                              <!doctype html>
                                                                                                                                                                                                                                                                                                                                                              <html lang="en">
                                                                                                                                                                                                                                                                                                                                                              <head>
                                                                                                                                                                                                                                                                                                                                                              <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                              <title>deferred.then demo</title>
                                                                                                                                                                                                                                                                                                                                                              <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                              </head>
                                                                                                                                                                                                                                                                                                                                                              <body>
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              <button>Filter Resolve</button>
                                                                                                                                                                                                                                                                                                                                                              <p></p>
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              <script>
                                                                                                                                                                                                                                                                                                                                                              var filterResolve = function() {
                                                                                                                                                                                                                                                                                                                                                              var defer = $.Deferred(),
                                                                                                                                                                                                                                                                                                                                                              filtered = defer.then(function( value ) {
                                                                                                                                                                                                                                                                                                                                                              return value * 2;
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              defer.resolve( 5 );
                                                                                                                                                                                                                                                                                                                                                              filtered.done(function( value ) {
                                                                                                                                                                                                                                                                                                                                                              $( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              $( "button" ).on( "click", filterResolve );
                                                                                                                                                                                                                                                                                                                                                              </script>
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              </body>
                                                                                                                                                                                                                                                                                                                                                              </html>
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.then( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                              var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                              chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARF = never
                                                                                                                                                                                                                                                                                                                                                              • AJF = never
                                                                                                                                                                                                                                                                                                                                                              • ANF = never
                                                                                                                                                                                                                                                                                                                                                              • BRF = never
                                                                                                                                                                                                                                                                                                                                                              • BJF = never
                                                                                                                                                                                                                                                                                                                                                              • BNF = never
                                                                                                                                                                                                                                                                                                                                                              • CRF = never
                                                                                                                                                                                                                                                                                                                                                              • CJF = never
                                                                                                                                                                                                                                                                                                                                                              • CNF = never
                                                                                                                                                                                                                                                                                                                                                              • RRF = never
                                                                                                                                                                                                                                                                                                                                                              • RJF = never
                                                                                                                                                                                                                                                                                                                                                              • RNF = never
                                                                                                                                                                                                                                                                                                                                                              • ARP = never
                                                                                                                                                                                                                                                                                                                                                              • AJP = never
                                                                                                                                                                                                                                                                                                                                                              • ANP = never
                                                                                                                                                                                                                                                                                                                                                              • BRP = never
                                                                                                                                                                                                                                                                                                                                                              • BJP = never
                                                                                                                                                                                                                                                                                                                                                              • BNP = never
                                                                                                                                                                                                                                                                                                                                                              • CRP = never
                                                                                                                                                                                                                                                                                                                                                              • CJP = never
                                                                                                                                                                                                                                                                                                                                                              • CNP = never
                                                                                                                                                                                                                                                                                                                                                              • RRP = never
                                                                                                                                                                                                                                                                                                                                                              • RJP = never
                                                                                                                                                                                                                                                                                                                                                              • RNP = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARF
                                                                                                                                                                                                                                                                                                                                                                  | ARP,
                                                                                                                                                                                                                                                                                                                                                                  AJF | AJP,
                                                                                                                                                                                                                                                                                                                                                                  ANF | ANP,
                                                                                                                                                                                                                                                                                                                                                                  BRF | BRP,
                                                                                                                                                                                                                                                                                                                                                                  BJF | BJP,
                                                                                                                                                                                                                                                                                                                                                                  BNF | BNP,
                                                                                                                                                                                                                                                                                                                                                                  CRF | CRP,
                                                                                                                                                                                                                                                                                                                                                                  CJF | CJP,
                                                                                                                                                                                                                                                                                                                                                                  CNF | CNP,
                                                                                                                                                                                                                                                                                                                                                                  RRF | RRP,
                                                                                                                                                                                                                                                                                                                                                                  RJF | RJP,
                                                                                                                                                                                                                                                                                                                                                                  RNF | RNP,
                                                                                                                                                                                                                                                                                                                                                              >

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.8

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.then( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                              var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                              chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARD = never
                                                                                                                                                                                                                                                                                                                                                              • AJD = never
                                                                                                                                                                                                                                                                                                                                                              • AND = never
                                                                                                                                                                                                                                                                                                                                                              • BRD = never
                                                                                                                                                                                                                                                                                                                                                              • BJD = never
                                                                                                                                                                                                                                                                                                                                                              • BND = never
                                                                                                                                                                                                                                                                                                                                                              • CRD = never
                                                                                                                                                                                                                                                                                                                                                              • CJD = never
                                                                                                                                                                                                                                                                                                                                                              • CND = never
                                                                                                                                                                                                                                                                                                                                                              • RRD = never
                                                                                                                                                                                                                                                                                                                                                              • RJD = never
                                                                                                                                                                                                                                                                                                                                                              • RND = never
                                                                                                                                                                                                                                                                                                                                                              • ARP = never
                                                                                                                                                                                                                                                                                                                                                              • AJP = never
                                                                                                                                                                                                                                                                                                                                                              • ANP = never
                                                                                                                                                                                                                                                                                                                                                              • BRP = never
                                                                                                                                                                                                                                                                                                                                                              • BJP = never
                                                                                                                                                                                                                                                                                                                                                              • BNP = never
                                                                                                                                                                                                                                                                                                                                                              • CRP = never
                                                                                                                                                                                                                                                                                                                                                              • CJP = never
                                                                                                                                                                                                                                                                                                                                                              • CNP = never
                                                                                                                                                                                                                                                                                                                                                              • RRP = never
                                                                                                                                                                                                                                                                                                                                                              • RJP = never
                                                                                                                                                                                                                                                                                                                                                              • RNP = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARD
                                                                                                                                                                                                                                                                                                                                                                  | ARP,
                                                                                                                                                                                                                                                                                                                                                                  AJD | AJP,
                                                                                                                                                                                                                                                                                                                                                                  AND | ANP,
                                                                                                                                                                                                                                                                                                                                                                  BRD | BRP,
                                                                                                                                                                                                                                                                                                                                                                  BJD | BJP,
                                                                                                                                                                                                                                                                                                                                                                  BND | BNP,
                                                                                                                                                                                                                                                                                                                                                                  CRD | CRP,
                                                                                                                                                                                                                                                                                                                                                                  CJD | CJP,
                                                                                                                                                                                                                                                                                                                                                                  CND | CNP,
                                                                                                                                                                                                                                                                                                                                                                  RRD | RRP,
                                                                                                                                                                                                                                                                                                                                                                  RJD | RJP,
                                                                                                                                                                                                                                                                                                                                                                  RND | RNP,
                                                                                                                                                                                                                                                                                                                                                              >

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.8

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Filter the resolve value: +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>deferred.then demo</title> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<button>Filter Resolve</button> +<p></p> +​ +<script> +var filterResolve = function() { +var defer = $.Deferred(), +filtered = defer.then(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +$( "p" ).html( "Value is ( 2*5 = ) 10: " + value ); +}); +}; +​ +$( "button" ).on( "click", filterResolve ); +</script> +​ +</body> +</html> +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                              var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                              chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARP = never
                                                                                                                                                                                                                                                                                                                                                              • AJP = never
                                                                                                                                                                                                                                                                                                                                                              • ANP = never
                                                                                                                                                                                                                                                                                                                                                              • BRP = never
                                                                                                                                                                                                                                                                                                                                                              • BJP = never
                                                                                                                                                                                                                                                                                                                                                              • BNP = never
                                                                                                                                                                                                                                                                                                                                                              • CRP = never
                                                                                                                                                                                                                                                                                                                                                              • CJP = never
                                                                                                                                                                                                                                                                                                                                                              • CNP = never
                                                                                                                                                                                                                                                                                                                                                              • RRP = never
                                                                                                                                                                                                                                                                                                                                                              • RJP = never
                                                                                                                                                                                                                                                                                                                                                              • RNP = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              • doneFilter: null

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                              • failFilter: null

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                              • OptionalprogressFilter: (
                                                                                                                                                                                                                                                                                                                                                                    t: TN,
                                                                                                                                                                                                                                                                                                                                                                    u: UN,
                                                                                                                                                                                                                                                                                                                                                                    v: VN,
                                                                                                                                                                                                                                                                                                                                                                    ...s: SN[],
                                                                                                                                                                                                                                                                                                                                                                ) =>
                                                                                                                                                                                                                                                                                                                                                                    | ANP
                                                                                                                                                                                                                                                                                                                                                                    | PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>
                                                                                                                                                                                                                                                                                                                                                                    | Thenable<ANP>

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<ARP, AJP, ANP, BRP, BJP, BNP, CRP, CJP, CNP, RRP, RJP, RNP>

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.8

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                              var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                              chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARD = never
                                                                                                                                                                                                                                                                                                                                                              • AJD = never
                                                                                                                                                                                                                                                                                                                                                              • AND = never
                                                                                                                                                                                                                                                                                                                                                              • BRD = never
                                                                                                                                                                                                                                                                                                                                                              • BJD = never
                                                                                                                                                                                                                                                                                                                                                              • BND = never
                                                                                                                                                                                                                                                                                                                                                              • CRD = never
                                                                                                                                                                                                                                                                                                                                                              • CJD = never
                                                                                                                                                                                                                                                                                                                                                              • CND = never
                                                                                                                                                                                                                                                                                                                                                              • RRD = never
                                                                                                                                                                                                                                                                                                                                                              • RJD = never
                                                                                                                                                                                                                                                                                                                                                              • RND = never
                                                                                                                                                                                                                                                                                                                                                              • ARF = never
                                                                                                                                                                                                                                                                                                                                                              • AJF = never
                                                                                                                                                                                                                                                                                                                                                              • ANF = never
                                                                                                                                                                                                                                                                                                                                                              • BRF = never
                                                                                                                                                                                                                                                                                                                                                              • BJF = never
                                                                                                                                                                                                                                                                                                                                                              • BNF = never
                                                                                                                                                                                                                                                                                                                                                              • CRF = never
                                                                                                                                                                                                                                                                                                                                                              • CJF = never
                                                                                                                                                                                                                                                                                                                                                              • CNF = never
                                                                                                                                                                                                                                                                                                                                                              • RRF = never
                                                                                                                                                                                                                                                                                                                                                              • RJF = never
                                                                                                                                                                                                                                                                                                                                                              • RNF = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<
                                                                                                                                                                                                                                                                                                                                                                  ARD
                                                                                                                                                                                                                                                                                                                                                                  | ARF,
                                                                                                                                                                                                                                                                                                                                                                  AJD | AJF,
                                                                                                                                                                                                                                                                                                                                                                  AND | ANF,
                                                                                                                                                                                                                                                                                                                                                                  BRD | BRF,
                                                                                                                                                                                                                                                                                                                                                                  BJD | BJF,
                                                                                                                                                                                                                                                                                                                                                                  BND | BNF,
                                                                                                                                                                                                                                                                                                                                                                  CRD | CRF,
                                                                                                                                                                                                                                                                                                                                                                  CJD | CJF,
                                                                                                                                                                                                                                                                                                                                                                  CND | CNF,
                                                                                                                                                                                                                                                                                                                                                                  RRD | RRF,
                                                                                                                                                                                                                                                                                                                                                                  RJD | RJF,
                                                                                                                                                                                                                                                                                                                                                                  RND | RNF,
                                                                                                                                                                                                                                                                                                                                                              >

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.8

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method. +```javascript +$.get( "test.php" ).then( +function() { +alert( "$.get succeeded" ); +}, function() { +alert( "$.get failed!" ); +} +); +``` +@example ​ ````Filter the resolve value:

                                                                                                                                                                                                                                                                                                                                                              <!doctype html>
                                                                                                                                                                                                                                                                                                                                                              <html lang="en">
                                                                                                                                                                                                                                                                                                                                                              <head>
                                                                                                                                                                                                                                                                                                                                                              <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                              <title>deferred.then demo</title>
                                                                                                                                                                                                                                                                                                                                                              <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                              </head>
                                                                                                                                                                                                                                                                                                                                                              <body>
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              <button>Filter Resolve</button>
                                                                                                                                                                                                                                                                                                                                                              <p></p>
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              <script>
                                                                                                                                                                                                                                                                                                                                                              var filterResolve = function() {
                                                                                                                                                                                                                                                                                                                                                              var defer = $.Deferred(),
                                                                                                                                                                                                                                                                                                                                                              filtered = defer.then(function( value ) {
                                                                                                                                                                                                                                                                                                                                                              return value * 2;
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              defer.resolve( 5 );
                                                                                                                                                                                                                                                                                                                                                              filtered.done(function( value ) {
                                                                                                                                                                                                                                                                                                                                                              $( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              $( "button" ).on( "click", filterResolve );
                                                                                                                                                                                                                                                                                                                                                              </script>
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              </body>
                                                                                                                                                                                                                                                                                                                                                              </html>
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.then( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                              var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                              chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARF = never
                                                                                                                                                                                                                                                                                                                                                              • AJF = never
                                                                                                                                                                                                                                                                                                                                                              • ANF = never
                                                                                                                                                                                                                                                                                                                                                              • BRF = never
                                                                                                                                                                                                                                                                                                                                                              • BJF = never
                                                                                                                                                                                                                                                                                                                                                              • BNF = never
                                                                                                                                                                                                                                                                                                                                                              • CRF = never
                                                                                                                                                                                                                                                                                                                                                              • CJF = never
                                                                                                                                                                                                                                                                                                                                                              • CNF = never
                                                                                                                                                                                                                                                                                                                                                              • RRF = never
                                                                                                                                                                                                                                                                                                                                                              • RJF = never
                                                                                                                                                                                                                                                                                                                                                              • RNF = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              • doneFilter: null

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                              • failFilter: (
                                                                                                                                                                                                                                                                                                                                                                    t: TJ,
                                                                                                                                                                                                                                                                                                                                                                    u: UJ,
                                                                                                                                                                                                                                                                                                                                                                    v: VJ,
                                                                                                                                                                                                                                                                                                                                                                    ...s: SJ[],
                                                                                                                                                                                                                                                                                                                                                                ) =>
                                                                                                                                                                                                                                                                                                                                                                    | ARF
                                                                                                                                                                                                                                                                                                                                                                    | PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>
                                                                                                                                                                                                                                                                                                                                                                    | Thenable<ARF>

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                              • OptionalprogressFilter: null

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<ARF, AJF, ANF, BRF, BJF, BNF, CRF, CJF, CNF, RRF, RJF, RNF>

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.8

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Filter reject value: +```javascript +var defer = $.Deferred(), +filtered = defer.then( null, function( value ) { +return value * 3; +}); +​ +defer.reject( 6 ); +filtered.fail(function( value ) { +alert( "Value is ( 3*6 = ) 18: " + value ); +}); +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                              var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                              chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • ARD = never
                                                                                                                                                                                                                                                                                                                                                              • AJD = never
                                                                                                                                                                                                                                                                                                                                                              • AND = never
                                                                                                                                                                                                                                                                                                                                                              • BRD = never
                                                                                                                                                                                                                                                                                                                                                              • BJD = never
                                                                                                                                                                                                                                                                                                                                                              • BND = never
                                                                                                                                                                                                                                                                                                                                                              • CRD = never
                                                                                                                                                                                                                                                                                                                                                              • CJD = never
                                                                                                                                                                                                                                                                                                                                                              • CND = never
                                                                                                                                                                                                                                                                                                                                                              • RRD = never
                                                                                                                                                                                                                                                                                                                                                              • RJD = never
                                                                                                                                                                                                                                                                                                                                                              • RND = never

                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                              • doneFilter: (
                                                                                                                                                                                                                                                                                                                                                                    t: TR,
                                                                                                                                                                                                                                                                                                                                                                    u: UR,
                                                                                                                                                                                                                                                                                                                                                                    v: VR,
                                                                                                                                                                                                                                                                                                                                                                    ...s: SR[],
                                                                                                                                                                                                                                                                                                                                                                ) =>
                                                                                                                                                                                                                                                                                                                                                                    | ARD
                                                                                                                                                                                                                                                                                                                                                                    | PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>
                                                                                                                                                                                                                                                                                                                                                                    | Thenable<ARD>

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when the Deferred is resolved.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                              • OptionalfailFilter: null

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when the Deferred is rejected.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                              • OptionalprogressFilter: null

                                                                                                                                                                                                                                                                                                                                                                An optional function that is called when progress notifications are sent to the Deferred.

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                              Returns PromiseBase<ARD, AJD, AND, BRD, BJD, BND, CRD, CJD, CND, RRD, RJD, RND>

                                                                                                                                                                                                                                                                                                                                                              <a href="https://api.jquery.com/deferred.then/">https://api.jquery.com/deferred.then/</a>

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              1.8

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Example: ​ ````Filter the resolve value: +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>deferred.then demo</title> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<button>Filter Resolve</button> +<p></p> +​ +<script> +var filterResolve = function() { +var defer = $.Deferred(), +filtered = defer.then(function( value ) { +return value * 2; +}); +​ +defer.resolve( 5 ); +filtered.done(function( value ) { +$( "p" ).html( "Value is ( 2*5 = ) 10: " + value ); +}); +}; +​ +$( "button" ).on( "click", filterResolve ); +</script> +​ +</body> +</html> +``` +@example ​ ````Chain tasks:

                                                                                                                                                                                                                                                                                                                                                              var request = $.ajax( url, { dataType: "json" } ),
                                                                                                                                                                                                                                                                                                                                                              chained = request.then(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              return $.ajax( url2, { data: { user: data.userId } } );
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              ​
                                                                                                                                                                                                                                                                                                                                                              chained.done(function( data ) {
                                                                                                                                                                                                                                                                                                                                                              // data retrieved from url2 as provided by the first request
                                                                                                                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.PromiseLike.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.PromiseLike.html new file mode 100644 index 000000000..ae66016cd --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.PromiseLike.html @@ -0,0 +1,6 @@ +PromiseLike | trilium
                                                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                              Interface PromiseLike<T>

                                                                                                                                                                                                                                                                                                                                                              interface PromiseLike<T> {
                                                                                                                                                                                                                                                                                                                                                                  then<TResult1 = T, TResult2 = never>(
                                                                                                                                                                                                                                                                                                                                                                      onfulfilled?: null | ((value: T) => TResult1 | PromiseLike<TResult1>),
                                                                                                                                                                                                                                                                                                                                                                      onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>),
                                                                                                                                                                                                                                                                                                                                                                  ): PromiseLike<TResult1 | TResult2>;
                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                              then +

                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.PromptDialogOptions.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.PromptDialogOptions.html new file mode 100644 index 000000000..dde8d30a0 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.PromptDialogOptions.html @@ -0,0 +1,6 @@ +PromptDialogOptions | trilium
                                                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                Interface PromptDialogOptions

                                                                                                                                                                                                                                                                                                                                                                interface PromptDialogOptions {
                                                                                                                                                                                                                                                                                                                                                                    callback?: (value: null | string) => void;
                                                                                                                                                                                                                                                                                                                                                                    defaultValue?: string;
                                                                                                                                                                                                                                                                                                                                                                    message?: string;
                                                                                                                                                                                                                                                                                                                                                                    shown?: PromptShownDialogCallback;
                                                                                                                                                                                                                                                                                                                                                                    title?: string;
                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                callback? +defaultValue? +message? +shown? +title? +

                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                callback?: (value: null | string) => void
                                                                                                                                                                                                                                                                                                                                                                defaultValue?: string
                                                                                                                                                                                                                                                                                                                                                                message?: string
                                                                                                                                                                                                                                                                                                                                                                shown?: PromptShownDialogCallback
                                                                                                                                                                                                                                                                                                                                                                title?: string

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ResolveOptions.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ResolveOptions.html new file mode 100644 index 000000000..45c2ad504 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ResolveOptions.html @@ -0,0 +1,4 @@ +ResolveOptions | trilium
                                                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                  Interface ResolveOptions

                                                                                                                                                                                                                                                                                                                                                                  interface ResolveOptions {
                                                                                                                                                                                                                                                                                                                                                                      deleteAllClones?: boolean;
                                                                                                                                                                                                                                                                                                                                                                      eraseNotes?: boolean;
                                                                                                                                                                                                                                                                                                                                                                      proceed: boolean;
                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  deleteAllClones? +eraseNotes? +proceed +

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  deleteAllClones?: boolean
                                                                                                                                                                                                                                                                                                                                                                  eraseNotes?: boolean
                                                                                                                                                                                                                                                                                                                                                                  proceed: boolean

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.SetNoteOpts.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.SetNoteOpts.html new file mode 100644 index 000000000..a8e3b89d9 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.SetNoteOpts.html @@ -0,0 +1,3 @@ +SetNoteOpts | trilium
                                                                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                    Interface SetNoteOpts

                                                                                                                                                                                                                                                                                                                                                                    interface SetNoteOpts {
                                                                                                                                                                                                                                                                                                                                                                        triggerSwitchEvent?: unknown;
                                                                                                                                                                                                                                                                                                                                                                        viewScope?: ViewScope;
                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                    triggerSwitchEvent? +viewScope? +

                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                    triggerSwitchEvent?: unknown
                                                                                                                                                                                                                                                                                                                                                                    viewScope?: ViewScope

                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ShownCallbackData.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ShownCallbackData.html new file mode 100644 index 000000000..086a13be7 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ShownCallbackData.html @@ -0,0 +1,5 @@ +ShownCallbackData | trilium
                                                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                      Interface ShownCallbackData

                                                                                                                                                                                                                                                                                                                                                                      interface ShownCallbackData {
                                                                                                                                                                                                                                                                                                                                                                          $answer: null | JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                                                                                                                          $dialog: JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                                                                                                                          $form: JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                                                                                                                          $question: null | JQuery<HTMLElement>;
                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      $answer +$dialog +$form +$question +

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      $answer: null | JQuery<HTMLElement>
                                                                                                                                                                                                                                                                                                                                                                      $dialog: JQuery<HTMLElement>
                                                                                                                                                                                                                                                                                                                                                                      $form: JQuery<HTMLElement>
                                                                                                                                                                                                                                                                                                                                                                      $question: null | JQuery<HTMLElement>

                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Table.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Table.html new file mode 100644 index 000000000..2247e56a1 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Table.html @@ -0,0 +1,9 @@ +Table | trilium
                                                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                        Interface Table

                                                                                                                                                                                                                                                                                                                                                                        Define table-extension options

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        interface Table {
                                                                                                                                                                                                                                                                                                                                                                            checkboxColumnIdx: any;
                                                                                                                                                                                                                                                                                                                                                                            indentation: number;
                                                                                                                                                                                                                                                                                                                                                                            nodeColumnIdx: number;
                                                                                                                                                                                                                                                                                                                                                                            [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                                                        • [key: string]: any

                                                                                                                                                                                                                                                                                                                                                                          Support misc options

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                        checkboxColumnIdx +indentation +nodeColumnIdx +

                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                        checkboxColumnIdx: any

                                                                                                                                                                                                                                                                                                                                                                        Render the checkboxes into the this column index (default: nodeColumnIdx)

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        indentation: number

                                                                                                                                                                                                                                                                                                                                                                        Indent every node level by 16px; default: 16

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        nodeColumnIdx: number

                                                                                                                                                                                                                                                                                                                                                                        Render node expander, icon, and title to this column (default: 0)

                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextEditor.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextEditor.html new file mode 100644 index 000000000..17de045ea --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextEditor.html @@ -0,0 +1,15 @@ +TextEditor | trilium
                                                                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                          Interface TextEditor

                                                                                                                                                                                                                                                                                                                                                                          interface TextEditor {
                                                                                                                                                                                                                                                                                                                                                                              conversion: {
                                                                                                                                                                                                                                                                                                                                                                                  for(
                                                                                                                                                                                                                                                                                                                                                                                      filter: string,
                                                                                                                                                                                                                                                                                                                                                                                  ): {
                                                                                                                                                                                                                                                                                                                                                                                      markerToHighlight(
                                                                                                                                                                                                                                                                                                                                                                                          data: { model: string; view: (data: { markerName: string }) => void },
                                                                                                                                                                                                                                                                                                                                                                                      ): any;
                                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                              data: {
                                                                                                                                                                                                                                                                                                                                                                                  processor: { toView(html: string): any };
                                                                                                                                                                                                                                                                                                                                                                                  toModel(viewFeragment: any): any;
                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                              editing: {
                                                                                                                                                                                                                                                                                                                                                                                  view: {
                                                                                                                                                                                                                                                                                                                                                                                      document: {
                                                                                                                                                                                                                                                                                                                                                                                          getRoot(): CKNode;
                                                                                                                                                                                                                                                                                                                                                                                          on(
                                                                                                                                                                                                                                                                                                                                                                                              event: string,
                                                                                                                                                                                                                                                                                                                                                                                              cb: (event: CKEvent, data: { preventDefault(): any }) => void,
                                                                                                                                                                                                                                                                                                                                                                                              opts?: { priority: "high" },
                                                                                                                                                                                                                                                                                                                                                                                          ): any;
                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                      domRoots: { values: () => { next: () => { value: string } } };
                                                                                                                                                                                                                                                                                                                                                                                      change(cb: (writer: Writer) => void): any;
                                                                                                                                                                                                                                                                                                                                                                                      focus(): void;
                                                                                                                                                                                                                                                                                                                                                                                      scrollToTheSelection(): void;
                                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                              model: {
                                                                                                                                                                                                                                                                                                                                                                                  document: {
                                                                                                                                                                                                                                                                                                                                                                                      differ: {
                                                                                                                                                                                                                                                                                                                                                                                          getChanges(): {
                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                              position?: { nodeAfter?: CKNode; parent: CKNode; toJSON(): Object };
                                                                                                                                                                                                                                                                                                                                                                                              type: string;
                                                                                                                                                                                                                                                                                                                                                                                          }[];
                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                      selection: {
                                                                                                                                                                                                                                                                                                                                                                                          isCollapsed: boolean;
                                                                                                                                                                                                                                                                                                                                                                                          getAttribute(attribute: string): string;
                                                                                                                                                                                                                                                                                                                                                                                          getFirstPosition(): undefined | TextPosition;
                                                                                                                                                                                                                                                                                                                                                                                          getFirstRange(): Range;
                                                                                                                                                                                                                                                                                                                                                                                          getLastPosition(): undefined | TextPosition;
                                                                                                                                                                                                                                                                                                                                                                                          getSelectedElement(): CKNode;
                                                                                                                                                                                                                                                                                                                                                                                          hasAttribute(attribute: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                      getRoot(): CKNode;
                                                                                                                                                                                                                                                                                                                                                                                      on(event: string, cb: () => void): any;
                                                                                                                                                                                                                                                                                                                                                                                      registerPostFixer(callback: (writer: Writer) => boolean): any;
                                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                                  change(cb: (writer: Writer) => void): any;
                                                                                                                                                                                                                                                                                                                                                                                  insertContent(modelFragment: any, selection?: any): any;
                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                              plugins: { get(command: string): any };
                                                                                                                                                                                                                                                                                                                                                                              sourceElement: HTMLElement;
                                                                                                                                                                                                                                                                                                                                                                              create(
                                                                                                                                                                                                                                                                                                                                                                                  el: HTMLElement,
                                                                                                                                                                                                                                                                                                                                                                                  config: {
                                                                                                                                                                                                                                                                                                                                                                                      mention: MentionConfig;
                                                                                                                                                                                                                                                                                                                                                                                      placeholder: string;
                                                                                                                                                                                                                                                                                                                                                                                      removePlugins?: string[];
                                                                                                                                                                                                                                                                                                                                                                                      toolbar: { items: any[] };
                                                                                                                                                                                                                                                                                                                                                                                  },
                                                                                                                                                                                                                                                                                                                                                                              ): any;
                                                                                                                                                                                                                                                                                                                                                                              enableReadOnlyMode(reason: string): any;
                                                                                                                                                                                                                                                                                                                                                                              execute<T>(action: string, ...args: unknown[]): T;
                                                                                                                                                                                                                                                                                                                                                                              focus(): void;
                                                                                                                                                                                                                                                                                                                                                                              getData(): string;
                                                                                                                                                                                                                                                                                                                                                                              getSelectedHtml(): string;
                                                                                                                                                                                                                                                                                                                                                                              removeSelection(): void;
                                                                                                                                                                                                                                                                                                                                                                              setData(data: string): void;
                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                          conversion +data +editing +model +plugins +sourceElement +

                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                          create +enableReadOnlyMode +execute +focus +getData +getSelectedHtml +removeSelection +setData +

                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                          conversion: {
                                                                                                                                                                                                                                                                                                                                                                              for(
                                                                                                                                                                                                                                                                                                                                                                                  filter: string,
                                                                                                                                                                                                                                                                                                                                                                              ): {
                                                                                                                                                                                                                                                                                                                                                                                  markerToHighlight(
                                                                                                                                                                                                                                                                                                                                                                                      data: { model: string; view: (data: { markerName: string }) => void },
                                                                                                                                                                                                                                                                                                                                                                                  ): any;
                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                          data: {
                                                                                                                                                                                                                                                                                                                                                                              processor: { toView(html: string): any };
                                                                                                                                                                                                                                                                                                                                                                              toModel(viewFeragment: any): any;
                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                          editing: {
                                                                                                                                                                                                                                                                                                                                                                              view: {
                                                                                                                                                                                                                                                                                                                                                                                  document: {
                                                                                                                                                                                                                                                                                                                                                                                      getRoot(): CKNode;
                                                                                                                                                                                                                                                                                                                                                                                      on(
                                                                                                                                                                                                                                                                                                                                                                                          event: string,
                                                                                                                                                                                                                                                                                                                                                                                          cb: (event: CKEvent, data: { preventDefault(): any }) => void,
                                                                                                                                                                                                                                                                                                                                                                                          opts?: { priority: "high" },
                                                                                                                                                                                                                                                                                                                                                                                      ): any;
                                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                                  domRoots: { values: () => { next: () => { value: string } } };
                                                                                                                                                                                                                                                                                                                                                                                  change(cb: (writer: Writer) => void): any;
                                                                                                                                                                                                                                                                                                                                                                                  focus(): void;
                                                                                                                                                                                                                                                                                                                                                                                  scrollToTheSelection(): void;
                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                          model: {
                                                                                                                                                                                                                                                                                                                                                                              document: {
                                                                                                                                                                                                                                                                                                                                                                                  differ: {
                                                                                                                                                                                                                                                                                                                                                                                      getChanges(): {
                                                                                                                                                                                                                                                                                                                                                                                          name: string;
                                                                                                                                                                                                                                                                                                                                                                                          position?: { nodeAfter?: CKNode; parent: CKNode; toJSON(): Object };
                                                                                                                                                                                                                                                                                                                                                                                          type: string;
                                                                                                                                                                                                                                                                                                                                                                                      }[];
                                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                                  selection: {
                                                                                                                                                                                                                                                                                                                                                                                      isCollapsed: boolean;
                                                                                                                                                                                                                                                                                                                                                                                      getAttribute(attribute: string): string;
                                                                                                                                                                                                                                                                                                                                                                                      getFirstPosition(): undefined | TextPosition;
                                                                                                                                                                                                                                                                                                                                                                                      getFirstRange(): Range;
                                                                                                                                                                                                                                                                                                                                                                                      getLastPosition(): undefined | TextPosition;
                                                                                                                                                                                                                                                                                                                                                                                      getSelectedElement(): CKNode;
                                                                                                                                                                                                                                                                                                                                                                                      hasAttribute(attribute: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                                  getRoot(): CKNode;
                                                                                                                                                                                                                                                                                                                                                                                  on(event: string, cb: () => void): any;
                                                                                                                                                                                                                                                                                                                                                                                  registerPostFixer(callback: (writer: Writer) => boolean): any;
                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                              change(cb: (writer: Writer) => void): any;
                                                                                                                                                                                                                                                                                                                                                                              insertContent(modelFragment: any, selection?: any): any;
                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                          plugins: { get(command: string): any }
                                                                                                                                                                                                                                                                                                                                                                          sourceElement: HTMLElement

                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                            • el: HTMLElement
                                                                                                                                                                                                                                                                                                                                                                            • config: {
                                                                                                                                                                                                                                                                                                                                                                                  mention: MentionConfig;
                                                                                                                                                                                                                                                                                                                                                                                  placeholder: string;
                                                                                                                                                                                                                                                                                                                                                                                  removePlugins?: string[];
                                                                                                                                                                                                                                                                                                                                                                                  toolbar: { items: any[] };
                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                            Returns any

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextNode.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextNode.html new file mode 100644 index 000000000..15687de89 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextNode.html @@ -0,0 +1,6 @@ +TextNode | trilium
                                                                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                            Interface TextNode

                                                                                                                                                                                                                                                                                                                                                                            interface TextNode {
                                                                                                                                                                                                                                                                                                                                                                                _attrs: { get(key: string): { length: number } };
                                                                                                                                                                                                                                                                                                                                                                                data: string;
                                                                                                                                                                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                                                                                                                                                                previousSibling?: TextNode;
                                                                                                                                                                                                                                                                                                                                                                                startOffset: number;
                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                            _attrs +data +name +previousSibling? +startOffset +

                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                            _attrs

                                                                                                                                                                                                                                                                                                                                                                            _attrs: { get(key: string): { length: number } }
                                                                                                                                                                                                                                                                                                                                                                            data: string
                                                                                                                                                                                                                                                                                                                                                                            name: string
                                                                                                                                                                                                                                                                                                                                                                            previousSibling?: TextNode
                                                                                                                                                                                                                                                                                                                                                                            startOffset: number

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextPosition.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextPosition.html new file mode 100644 index 000000000..fb3d86028 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextPosition.html @@ -0,0 +1,4 @@ +TextPosition | trilium
                                                                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                              Interface TextPosition

                                                                                                                                                                                                                                                                                                                                                                              interface TextPosition {
                                                                                                                                                                                                                                                                                                                                                                                  offset: number;
                                                                                                                                                                                                                                                                                                                                                                                  textNode: TextNode;
                                                                                                                                                                                                                                                                                                                                                                                  compareWith(pos: TextPosition): string;
                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              offset +textNode +

                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                              compareWith +

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              offset: number
                                                                                                                                                                                                                                                                                                                                                                              textNode: TextNode

                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextRange.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextRange.html new file mode 100644 index 000000000..e42ab04aa --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.TextRange.html @@ -0,0 +1 @@ +TextRange | trilium
                                                                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                Interface TextRange

                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Thenable.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Thenable.html new file mode 100644 index 000000000..ad52949a2 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Thenable.html @@ -0,0 +1,7 @@ +Thenable | trilium
                                                                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                  Interface Thenable<T>

                                                                                                                                                                                                                                                                                                                                                                                  Any object that has a then method.

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  interface Thenable<T> {
                                                                                                                                                                                                                                                                                                                                                                                      then<TResult1 = T, TResult2 = never>(
                                                                                                                                                                                                                                                                                                                                                                                          onfulfilled?: null | ((value: T) => TResult1 | PromiseLike<TResult1>),
                                                                                                                                                                                                                                                                                                                                                                                          onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>),
                                                                                                                                                                                                                                                                                                                                                                                      ): PromiseLike<TResult1 | TResult2>;
                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                  • T

                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                  then +

                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TranslationTable.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.TranslationTable.html new file mode 100644 index 000000000..227f61cd6 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.TranslationTable.html @@ -0,0 +1,9 @@ +TranslationTable | trilium
                                                                                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                    Interface TranslationTable

                                                                                                                                                                                                                                                                                                                                                                                    interface TranslationTable {
                                                                                                                                                                                                                                                                                                                                                                                        loadError?: string;
                                                                                                                                                                                                                                                                                                                                                                                        loading?: string;
                                                                                                                                                                                                                                                                                                                                                                                        moreData?: string;
                                                                                                                                                                                                                                                                                                                                                                                        noData?: string;
                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                    loadError? +loading? +moreData? +noData? +

                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                    loadError?: string

                                                                                                                                                                                                                                                                                                                                                                                    "Load error!"

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    loading?: string

                                                                                                                                                                                                                                                                                                                                                                                    "Loading..." // … would be escaped when escapeTitles is true

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    moreData?: string

                                                                                                                                                                                                                                                                                                                                                                                    "More..."

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    noData?: string

                                                                                                                                                                                                                                                                                                                                                                                    "No data."

                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.TriggeredEvent.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.TriggeredEvent.html new file mode 100644 index 000000000..8a0477ea5 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.TriggeredEvent.html @@ -0,0 +1,212 @@ +TriggeredEvent | trilium
                                                                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                      Interface TriggeredEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>

                                                                                                                                                                                                                                                                                                                                                                                      Base type for jQuery events that have been triggered (including events triggered on plain objects).

                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      interface TriggeredEvent<
                                                                                                                                                                                                                                                                                                                                                                                          TDelegateTarget = any,
                                                                                                                                                                                                                                                                                                                                                                                          TData = any,
                                                                                                                                                                                                                                                                                                                                                                                          TCurrentTarget = any,
                                                                                                                                                                                                                                                                                                                                                                                          TTarget = any,
                                                                                                                                                                                                                                                                                                                                                                                      > {
                                                                                                                                                                                                                                                                                                                                                                                          altKey: undefined | boolean;
                                                                                                                                                                                                                                                                                                                                                                                          bubbles: undefined | boolean;
                                                                                                                                                                                                                                                                                                                                                                                          button: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          buttons: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          cancelable: undefined | boolean;
                                                                                                                                                                                                                                                                                                                                                                                          changedTouches: undefined | TouchList;
                                                                                                                                                                                                                                                                                                                                                                                          char: undefined | string;
                                                                                                                                                                                                                                                                                                                                                                                          charCode: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          clientX: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          clientY: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          ctrlKey: undefined | boolean;
                                                                                                                                                                                                                                                                                                                                                                                          currentTarget: TCurrentTarget;
                                                                                                                                                                                                                                                                                                                                                                                          data: TData;
                                                                                                                                                                                                                                                                                                                                                                                          delegateTarget: TDelegateTarget;
                                                                                                                                                                                                                                                                                                                                                                                          detail: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          eventPhase: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          key: undefined | string;
                                                                                                                                                                                                                                                                                                                                                                                          keyCode: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          metaKey: undefined | boolean;
                                                                                                                                                                                                                                                                                                                                                                                          namespace?: string;
                                                                                                                                                                                                                                                                                                                                                                                          offsetX: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          offsetY: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          originalEvent?: Event;
                                                                                                                                                                                                                                                                                                                                                                                          pageX: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          pageY: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          pointerId: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          pointerType: undefined | string;
                                                                                                                                                                                                                                                                                                                                                                                          result?: any;
                                                                                                                                                                                                                                                                                                                                                                                          screenX: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          screenY: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          shiftKey: undefined | boolean;
                                                                                                                                                                                                                                                                                                                                                                                          target: TTarget;
                                                                                                                                                                                                                                                                                                                                                                                          targetTouches: undefined | TouchList;
                                                                                                                                                                                                                                                                                                                                                                                          timeStamp: number;
                                                                                                                                                                                                                                                                                                                                                                                          toElement: undefined | Element;
                                                                                                                                                                                                                                                                                                                                                                                          touches: undefined | TouchList;
                                                                                                                                                                                                                                                                                                                                                                                          type: string;
                                                                                                                                                                                                                                                                                                                                                                                          view: undefined | Window;
                                                                                                                                                                                                                                                                                                                                                                                          which: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                          isDefaultPrevented(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                          isImmediatePropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                          isPropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                          preventDefault(): void;
                                                                                                                                                                                                                                                                                                                                                                                          stopImmediatePropagation(): void;
                                                                                                                                                                                                                                                                                                                                                                                          stopPropagation(): void;
                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                      • TDelegateTarget = any
                                                                                                                                                                                                                                                                                                                                                                                      • TData = any
                                                                                                                                                                                                                                                                                                                                                                                      • TCurrentTarget = any
                                                                                                                                                                                                                                                                                                                                                                                      • TTarget = any

                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                      altKey +bubbles +button +buttons +cancelable +changedTouches +char +charCode +clientX +clientY +ctrlKey +currentTarget +data +delegateTarget +detail +eventPhase +key +keyCode +metaKey +namespace? +offsetX +offsetY +originalEvent? +pageX +pageY +pointerId +pointerType +result? +screenX +screenY +shiftKey +target +targetTouches +timeStamp +toElement +touches +type +view +which +

                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                      isDefaultPrevented +isImmediatePropagationStopped +isPropagationStopped +preventDefault +stopImmediatePropagation +stopPropagation +

                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                      altKey: undefined | boolean
                                                                                                                                                                                                                                                                                                                                                                                      bubbles: undefined | boolean
                                                                                                                                                                                                                                                                                                                                                                                      button: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                      buttons: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                      cancelable: undefined | boolean
                                                                                                                                                                                                                                                                                                                                                                                      changedTouches: undefined | TouchList
                                                                                                                                                                                                                                                                                                                                                                                      char: undefined | string
                                                                                                                                                                                                                                                                                                                                                                                      charCode: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                      clientX: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                      clientY: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                      ctrlKey: undefined | boolean
                                                                                                                                                                                                                                                                                                                                                                                      currentTarget: TCurrentTarget

                                                                                                                                                                                                                                                                                                                                                                                      The current DOM element within the event bubbling phase.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.currentTarget/">https://api.jquery.com/event.currentTarget/</a>

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      1.3

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Example: ​ ````Alert that currentTarget matches the `this` keyword.

                                                                                                                                                                                                                                                                                                                                                                                      $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                      alert( event.currentTarget === this ); // true
                                                                                                                                                                                                                                                                                                                                                                                      });
+
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      data: TData

                                                                                                                                                                                                                                                                                                                                                                                      An optional object of data passed to an event method when the current executing handler is bound.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.data/">https://api.jquery.com/event.data/</a>

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      1.1

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Example: ​ ````Within a for loop, pass the value of i to the .on() method so that the current iteration&#39;s value is preserved.

                                                                                                                                                                                                                                                                                                                                                                                      <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                      <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                      <head>
                                                                                                                                                                                                                                                                                                                                                                                      <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                      <title>event.data demo</title>
                                                                                                                                                                                                                                                                                                                                                                                      <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                      </head>
                                                                                                                                                                                                                                                                                                                                                                                      <body>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <button> 0 </button>
                                                                                                                                                                                                                                                                                                                                                                                      <button> 1 </button>
                                                                                                                                                                                                                                                                                                                                                                                      <button> 2 </button>
                                                                                                                                                                                                                                                                                                                                                                                      <button> 3 </button>
                                                                                                                                                                                                                                                                                                                                                                                      <button> 4 </button>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <script>
                                                                                                                                                                                                                                                                                                                                                                                      var logDiv = $( "#log" );
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      for ( var i = 0; i < 5; i++ ) {
                                                                                                                                                                                                                                                                                                                                                                                      $( "button" ).eq( i ).on( "click", { value: i }, function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                      var msgs = [
                                                                                                                                                                                                                                                                                                                                                                                      "button = " + $( this ).index(),
                                                                                                                                                                                                                                                                                                                                                                                      "event.data.value = " + event.data.value,
                                                                                                                                                                                                                                                                                                                                                                                      "i = " + i
                                                                                                                                                                                                                                                                                                                                                                                      ];
                                                                                                                                                                                                                                                                                                                                                                                      logDiv.append( msgs.join( ", " ) + "<br>" );
                                                                                                                                                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      </script>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      </body>
                                                                                                                                                                                                                                                                                                                                                                                      </html>
+
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      delegateTarget: TDelegateTarget

                                                                                                                                                                                                                                                                                                                                                                                      The element where the currently-called jQuery event handler was attached.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.delegateTarget/">https://api.jquery.com/event.delegateTarget/</a>

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      1.7

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Example: ​ ````When a button in any box class is clicked, change the box&#39;s background color to red.

                                                                                                                                                                                                                                                                                                                                                                                      $( ".box" ).on( "click", "button", function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                      $( event.delegateTarget ).css( "background-color", "red" );
                                                                                                                                                                                                                                                                                                                                                                                      });
+
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      detail: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                      eventPhase: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                      key: undefined | string
                                                                                                                                                                                                                                                                                                                                                                                      keyCode: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                      metaKey: undefined | boolean

                                                                                                                                                                                                                                                                                                                                                                                      Indicates whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.metaKey/">https://api.jquery.com/event.metaKey/</a>

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      1.0.4

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Example: ​ ````Determine whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                                                                                                                                      <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                      <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                      <head>
                                                                                                                                                                                                                                                                                                                                                                                      <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                      <title>event.metaKey demo</title>
                                                                                                                                                                                                                                                                                                                                                                                      <style>
                                                                                                                                                                                                                                                                                                                                                                                      body {
                                                                                                                                                                                                                                                                                                                                                                                      background-color: #eef;
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      div {
                                                                                                                                                                                                                                                                                                                                                                                      padding: 20px;
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      </style>
                                                                                                                                                                                                                                                                                                                                                                                      <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                      </head>
                                                                                                                                                                                                                                                                                                                                                                                      <body>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <button value="Test" name="Test" id="checkMetaKey">Click me!</button>
                                                                                                                                                                                                                                                                                                                                                                                      <div id="display"></div>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <script>
                                                                                                                                                                                                                                                                                                                                                                                      $( "#checkMetaKey" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                      $( "#display" ).text( event.metaKey );
                                                                                                                                                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                                                                                                                                                      </script>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      </body>
                                                                                                                                                                                                                                                                                                                                                                                      </html>
+
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      namespace?: string

                                                                                                                                                                                                                                                                                                                                                                                      The namespace specified when the event was triggered.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.namespace/">https://api.jquery.com/event.namespace/</a>

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      1.4.3

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Example: ​ ````Determine the event namespace used.

                                                                                                                                                                                                                                                                                                                                                                                      <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                      <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                      <head>
                                                                                                                                                                                                                                                                                                                                                                                      <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                      <title>event.namespace demo</title>
                                                                                                                                                                                                                                                                                                                                                                                      <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                      </head>
                                                                                                                                                                                                                                                                                                                                                                                      <body>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <button>display event.namespace</button>
                                                                                                                                                                                                                                                                                                                                                                                      <p></p>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <script>
                                                                                                                                                                                                                                                                                                                                                                                      $( "p" ).on( "test.something", function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                      alert( event.namespace );
                                                                                                                                                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                                                                                                                                                      $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                      $( "p" ).trigger( "test.something" );
                                                                                                                                                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                                                                                                                                                      </script>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      </body>
                                                                                                                                                                                                                                                                                                                                                                                      </html>
+
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      offsetX: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                      offsetY: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                      originalEvent?: Event
                                                                                                                                                                                                                                                                                                                                                                                      pageX: undefined | number

                                                                                                                                                                                                                                                                                                                                                                                      The mouse position relative to the left edge of the document.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.pageX/">https://api.jquery.com/event.pageX/</a>

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      1.0.4

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Example: ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe).

                                                                                                                                                                                                                                                                                                                                                                                      <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                      <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                      <head>
                                                                                                                                                                                                                                                                                                                                                                                      <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                      <title>event.pageX demo</title>
                                                                                                                                                                                                                                                                                                                                                                                      <style>
                                                                                                                                                                                                                                                                                                                                                                                      body {
                                                                                                                                                                                                                                                                                                                                                                                      background-color: #eef;
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      div {
                                                                                                                                                                                                                                                                                                                                                                                      padding: 20px;
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      </style>
                                                                                                                                                                                                                                                                                                                                                                                      <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                      </head>
                                                                                                                                                                                                                                                                                                                                                                                      <body>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <script>
                                                                                                                                                                                                                                                                                                                                                                                      $( document ).on( "mousemove", function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                      $( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
                                                                                                                                                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                                                                                                                                                      </script>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      </body>
                                                                                                                                                                                                                                                                                                                                                                                      </html>
+
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      pageY: undefined | number

                                                                                                                                                                                                                                                                                                                                                                                      The mouse position relative to the top edge of the document.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.pageY/">https://api.jquery.com/event.pageY/</a>

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      1.0.4

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Example: ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe).

                                                                                                                                                                                                                                                                                                                                                                                      <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                      <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                      <head>
                                                                                                                                                                                                                                                                                                                                                                                      <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                      <title>event.pageY demo</title>
                                                                                                                                                                                                                                                                                                                                                                                      <style>
                                                                                                                                                                                                                                                                                                                                                                                      body {
                                                                                                                                                                                                                                                                                                                                                                                      background-color: #eef;
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      div {
                                                                                                                                                                                                                                                                                                                                                                                      padding: 20px;
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      </style>
                                                                                                                                                                                                                                                                                                                                                                                      <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                      </head>
                                                                                                                                                                                                                                                                                                                                                                                      <body>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <script>
                                                                                                                                                                                                                                                                                                                                                                                      $( document ).on( "mousemove", function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                      $( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
                                                                                                                                                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                                                                                                                                                      </script>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      </body>
                                                                                                                                                                                                                                                                                                                                                                                      </html>
+
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      pointerId: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                      pointerType: undefined | string
                                                                                                                                                                                                                                                                                                                                                                                      result?: any

                                                                                                                                                                                                                                                                                                                                                                                      The last value returned by an event handler that was triggered by this event, unless the value was undefined.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.result/">https://api.jquery.com/event.result/</a>

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      1.3

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Example: ​ ````Display previous handler&#39;s return value

                                                                                                                                                                                                                                                                                                                                                                                      <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                      <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                      <head>
                                                                                                                                                                                                                                                                                                                                                                                      <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                      <title>event.result demo</title>
                                                                                                                                                                                                                                                                                                                                                                                      <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                      </head>
                                                                                                                                                                                                                                                                                                                                                                                      <body>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <button>display event.result</button>
                                                                                                                                                                                                                                                                                                                                                                                      <p></p>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <script>
                                                                                                                                                                                                                                                                                                                                                                                      $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                      return "hey";
                                                                                                                                                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                                                                                                                                                      $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                      $( "p" ).html( event.result );
                                                                                                                                                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                                                                                                                                                      </script>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      </body>
                                                                                                                                                                                                                                                                                                                                                                                      </html>
+
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      screenX: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                      screenY: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                      shiftKey: undefined | boolean
                                                                                                                                                                                                                                                                                                                                                                                      target: TTarget

                                                                                                                                                                                                                                                                                                                                                                                      The DOM element that initiated the event.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.target/">https://api.jquery.com/event.target/</a>

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      1.0

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Example: ​ ````Display the tag&#39;s name on click +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>event.target demo</title> +<style> +span, strong, p { +padding: 8px; +display: block; +border: 1px solid #999; +} +</style> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<div id="log"></div> +<div> +<p> +<strong><span>click</span></strong> +</p> +</div> +​ +<script> +$( "body" ).click(function( event ) { +$( "#log" ).html( "clicked: " + event.target.nodeName ); +}); +</script> +​ +</body> +</html> +``` +@example ​ ````Implements a simple event delegation: The click handler is added to an unordered list, and the children of its li children are hidden. Clicking one of the li children toggles (see toggle()) their children.

                                                                                                                                                                                                                                                                                                                                                                                      <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                      <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                      <head>
                                                                                                                                                                                                                                                                                                                                                                                      <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                      <title>event.target demo</title>
                                                                                                                                                                                                                                                                                                                                                                                      <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                      </head>
                                                                                                                                                                                                                                                                                                                                                                                      <body>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <ul>
                                                                                                                                                                                                                                                                                                                                                                                      <li>item 1
                                                                                                                                                                                                                                                                                                                                                                                      <ul>
                                                                                                                                                                                                                                                                                                                                                                                      <li>sub item 1-a</li>
                                                                                                                                                                                                                                                                                                                                                                                      <li>sub item 1-b</li>
                                                                                                                                                                                                                                                                                                                                                                                      </ul>
                                                                                                                                                                                                                                                                                                                                                                                      </li>
                                                                                                                                                                                                                                                                                                                                                                                      <li>item 2
                                                                                                                                                                                                                                                                                                                                                                                      <ul>
                                                                                                                                                                                                                                                                                                                                                                                      <li>sub item 2-a</li>
                                                                                                                                                                                                                                                                                                                                                                                      <li>sub item 2-b</li>
                                                                                                                                                                                                                                                                                                                                                                                      </ul>
                                                                                                                                                                                                                                                                                                                                                                                      </li>
                                                                                                                                                                                                                                                                                                                                                                                      </ul>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <script>
                                                                                                                                                                                                                                                                                                                                                                                      function handler( event ) {
                                                                                                                                                                                                                                                                                                                                                                                      var target = $( event.target );
                                                                                                                                                                                                                                                                                                                                                                                      if ( target.is( "li" ) ) {
                                                                                                                                                                                                                                                                                                                                                                                      target.children().toggle();
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      $( "ul" ).click( handler ).find( "ul" ).hide();
                                                                                                                                                                                                                                                                                                                                                                                      </script>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      </body>
                                                                                                                                                                                                                                                                                                                                                                                      </html>
+
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      targetTouches: undefined | TouchList
                                                                                                                                                                                                                                                                                                                                                                                      timeStamp: number

                                                                                                                                                                                                                                                                                                                                                                                      The difference in milliseconds between the time the browser created the event and January 1, 1970.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.timeStamp/">https://api.jquery.com/event.timeStamp/</a>

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      1.2.6

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Example: ​ ````Display the time since the click handler last executed.

                                                                                                                                                                                                                                                                                                                                                                                      <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                      <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                      <head>
                                                                                                                                                                                                                                                                                                                                                                                      <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                      <title>event.timeStamp demo</title>
                                                                                                                                                                                                                                                                                                                                                                                      <style>
                                                                                                                                                                                                                                                                                                                                                                                      div {
                                                                                                                                                                                                                                                                                                                                                                                      height: 100px;
                                                                                                                                                                                                                                                                                                                                                                                      width: 300px;
                                                                                                                                                                                                                                                                                                                                                                                      margin: 10px;
                                                                                                                                                                                                                                                                                                                                                                                      background-color: #ffd;
                                                                                                                                                                                                                                                                                                                                                                                      overflow: auto;
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      </style>
                                                                                                                                                                                                                                                                                                                                                                                      <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                      </head>
                                                                                                                                                                                                                                                                                                                                                                                      <body>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <div>Click.</div>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <script>
                                                                                                                                                                                                                                                                                                                                                                                      var last, diff;
                                                                                                                                                                                                                                                                                                                                                                                      $( "div" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                      if ( last ) {
                                                                                                                                                                                                                                                                                                                                                                                      diff = event.timeStamp - last;
                                                                                                                                                                                                                                                                                                                                                                                      $( "div" ).append( "time since last event: " + diff + "<br>" );
                                                                                                                                                                                                                                                                                                                                                                                      } else {
                                                                                                                                                                                                                                                                                                                                                                                      $( "div" ).append( "Click again.<br>" );
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      last = event.timeStamp;
                                                                                                                                                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                                                                                                                                                      </script>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      </body>
                                                                                                                                                                                                                                                                                                                                                                                      </html>
+
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      toElement: undefined | Element
                                                                                                                                                                                                                                                                                                                                                                                      touches: undefined | TouchList
                                                                                                                                                                                                                                                                                                                                                                                      type: string

                                                                                                                                                                                                                                                                                                                                                                                      Describes the nature of the event.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.type/">https://api.jquery.com/event.type/</a>

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      1.0

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Example: ​ ````On all anchor clicks, alert the event type.

                                                                                                                                                                                                                                                                                                                                                                                      $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                      alert( event.type ); // "click"
                                                                                                                                                                                                                                                                                                                                                                                      });
+
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      view: undefined | Window
                                                                                                                                                                                                                                                                                                                                                                                      which: undefined | number

                                                                                                                                                                                                                                                                                                                                                                                      For key or mouse events, this property indicates the specific key or button that was pressed.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      <a href="https://api.jquery.com/event.which/">https://api.jquery.com/event.which/</a>

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      1.1.3

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Example: ​ ````Log which key was depressed. +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>event.which demo</title> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<input id="whichkey" value="type something"> +<div id="log"></div> +​ +<script> +$( "#whichkey" ).on( "keydown", function( event ) { +$( "#log" ).html( event.type + ": " + event.which ); +}); +</script> +​ +</body> +</html> +``` +@example ​ ````Log which mouse button was depressed.

                                                                                                                                                                                                                                                                                                                                                                                      <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                      <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                      <head>
                                                                                                                                                                                                                                                                                                                                                                                      <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                      <title>event.which demo</title>
                                                                                                                                                                                                                                                                                                                                                                                      <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                      </head>
                                                                                                                                                                                                                                                                                                                                                                                      <body>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <input id="whichkey" value="click here">
                                                                                                                                                                                                                                                                                                                                                                                      <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      <script>
                                                                                                                                                                                                                                                                                                                                                                                      $( "#whichkey" ).on( "mousedown", function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                      $( "#log" ).html( event.type + ": " +  event.which );
                                                                                                                                                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                                                                                                                                                      </script>
                                                                                                                                                                                                                                                                                                                                                                                      ​
                                                                                                                                                                                                                                                                                                                                                                                      </body>
                                                                                                                                                                                                                                                                                                                                                                                      </html>
+
                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                      • Returns whether event.preventDefault() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.isDefaultPrevented/">https://api.jquery.com/event.isDefaultPrevented/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.3

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Checks whether event.preventDefault() was called.

                                                                                                                                                                                                                                                                                                                                                                                        $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        alert( event.isDefaultPrevented() ); // false
                                                                                                                                                                                                                                                                                                                                                                                        event.preventDefault();
                                                                                                                                                                                                                                                                                                                                                                                        alert( event.isDefaultPrevented() ); // true
                                                                                                                                                                                                                                                                                                                                                                                        });
+
                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                      • Returns whether event.stopImmediatePropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.isImmediatePropagationStopped/">https://api.jquery.com/event.isImmediatePropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.3

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Checks whether event.stopImmediatePropagation() was called.

                                                                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                        <title>event.isImmediatePropagationStopped demo</title>
                                                                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <button>click me</button>
                                                                                                                                                                                                                                                                                                                                                                                        <div id="stop-log"></div>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                                                                        function immediatePropStopped( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        var msg = "";
                                                                                                                                                                                                                                                                                                                                                                                        if ( event.isImmediatePropagationStopped() ) {
                                                                                                                                                                                                                                                                                                                                                                                        msg = "called";
                                                                                                                                                                                                                                                                                                                                                                                        } else {
                                                                                                                                                                                                                                                                                                                                                                                        msg = "not called";
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        $( "#stop-log" ).append( "<div>" + msg + "</div>" );
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        immediatePropStopped( event );
                                                                                                                                                                                                                                                                                                                                                                                        event.stopImmediatePropagation();
                                                                                                                                                                                                                                                                                                                                                                                        immediatePropStopped( event );
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                      • Returns whether event.stopPropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.isPropagationStopped/">https://api.jquery.com/event.isPropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.3

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Checks whether event.stopPropagation() was called

                                                                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                        <title>event.isPropagationStopped demo</title>
                                                                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <button>click me</button>
                                                                                                                                                                                                                                                                                                                                                                                        <div id="stop-log"></div>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                                                                        function propStopped( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        var msg = "";
                                                                                                                                                                                                                                                                                                                                                                                        if ( event.isPropagationStopped() ) {
                                                                                                                                                                                                                                                                                                                                                                                        msg = "called";
                                                                                                                                                                                                                                                                                                                                                                                        } else {
                                                                                                                                                                                                                                                                                                                                                                                        msg = "not called";
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        $( "#stop-log" ).append( "<div>" + msg + "</div>" );
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        $( "button" ).click(function(event) {
                                                                                                                                                                                                                                                                                                                                                                                        propStopped( event );
                                                                                                                                                                                                                                                                                                                                                                                        event.stopPropagation();
                                                                                                                                                                                                                                                                                                                                                                                        propStopped( event );
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                      • If this method is called, the default action of the event will not be triggered.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.preventDefault/">https://api.jquery.com/event.preventDefault/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.0

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Cancel the default action (navigation) of the click.

                                                                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                        <title>event.preventDefault demo</title>
                                                                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://jquery.com">default click action is prevented</a>
                                                                                                                                                                                                                                                                                                                                                                                        <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                                                                        $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        event.preventDefault();
                                                                                                                                                                                                                                                                                                                                                                                        $( "<div>" )
                                                                                                                                                                                                                                                                                                                                                                                        .append( "default " + event.type + " prevented" )
                                                                                                                                                                                                                                                                                                                                                                                        .appendTo( "#log" );
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                      • Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.stopImmediatePropagation/">https://api.jquery.com/event.stopImmediatePropagation/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.3

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Prevents other event handlers from being called.

                                                                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                        <title>event.stopImmediatePropagation demo</title>
                                                                                                                                                                                                                                                                                                                                                                                        <style>
                                                                                                                                                                                                                                                                                                                                                                                        p {
                                                                                                                                                                                                                                                                                                                                                                                        height: 30px;
                                                                                                                                                                                                                                                                                                                                                                                        width: 150px;
                                                                                                                                                                                                                                                                                                                                                                                        background-color: #ccf;
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        div {
                                                                                                                                                                                                                                                                                                                                                                                        height: 30px;
                                                                                                                                                                                                                                                                                                                                                                                        width: 150px;
                                                                                                                                                                                                                                                                                                                                                                                        background-color: #cfc;
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        </style>
                                                                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <p>paragraph</p>
                                                                                                                                                                                                                                                                                                                                                                                        <div>division</div>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                                                                        $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        event.stopImmediatePropagation();
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        // This function won't be executed
                                                                                                                                                                                                                                                                                                                                                                                        $( this ).css( "background-color", "#f00" );
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        $( "div" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        // This function will be executed
                                                                                                                                                                                                                                                                                                                                                                                        $( this ).css( "background-color", "#f00" );
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                      • Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.stopPropagation/">https://api.jquery.com/event.stopPropagation/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.0

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Kill the bubbling on the click event.

                                                                                                                                                                                                                                                                                                                                                                                        $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        event.stopPropagation();
                                                                                                                                                                                                                                                                                                                                                                                        // Do something
                                                                                                                                                                                                                                                                                                                                                                                        });
+
                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.UIEventBase.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.UIEventBase.html new file mode 100644 index 000000000..55a1c63f2 --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.UIEventBase.html @@ -0,0 +1,212 @@ +UIEventBase | trilium
                                                                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                        Interface UIEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget>

                                                                                                                                                                                                                                                                                                                                                                                        Base type for jQuery events that have been triggered (including events triggered on plain objects).

                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        interface UIEventBase<
                                                                                                                                                                                                                                                                                                                                                                                            TDelegateTarget = any,
                                                                                                                                                                                                                                                                                                                                                                                            TData = any,
                                                                                                                                                                                                                                                                                                                                                                                            TCurrentTarget = any,
                                                                                                                                                                                                                                                                                                                                                                                            TTarget = any,
                                                                                                                                                                                                                                                                                                                                                                                        > {
                                                                                                                                                                                                                                                                                                                                                                                            altKey: undefined | boolean;
                                                                                                                                                                                                                                                                                                                                                                                            bubbles: boolean;
                                                                                                                                                                                                                                                                                                                                                                                            button: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                            buttons: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                            cancelable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                            changedTouches: undefined | TouchList;
                                                                                                                                                                                                                                                                                                                                                                                            char: undefined | string;
                                                                                                                                                                                                                                                                                                                                                                                            charCode: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                            clientX: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                            clientY: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                            ctrlKey: undefined | boolean;
                                                                                                                                                                                                                                                                                                                                                                                            currentTarget: TCurrentTarget;
                                                                                                                                                                                                                                                                                                                                                                                            data: TData;
                                                                                                                                                                                                                                                                                                                                                                                            delegateTarget: TDelegateTarget;
                                                                                                                                                                                                                                                                                                                                                                                            detail: number;
                                                                                                                                                                                                                                                                                                                                                                                            eventPhase: number;
                                                                                                                                                                                                                                                                                                                                                                                            key: undefined | string;
                                                                                                                                                                                                                                                                                                                                                                                            keyCode: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                            metaKey: undefined | boolean;
                                                                                                                                                                                                                                                                                                                                                                                            namespace?: string;
                                                                                                                                                                                                                                                                                                                                                                                            offsetX: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                            offsetY: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                            originalEvent?: UIEvent;
                                                                                                                                                                                                                                                                                                                                                                                            pageX: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                            pageY: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                            pointerId: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                            pointerType: undefined | string;
                                                                                                                                                                                                                                                                                                                                                                                            result?: any;
                                                                                                                                                                                                                                                                                                                                                                                            screenX: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                            screenY: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                            shiftKey: undefined | boolean;
                                                                                                                                                                                                                                                                                                                                                                                            target: TTarget;
                                                                                                                                                                                                                                                                                                                                                                                            targetTouches: undefined | TouchList;
                                                                                                                                                                                                                                                                                                                                                                                            timeStamp: number;
                                                                                                                                                                                                                                                                                                                                                                                            toElement: undefined | Element;
                                                                                                                                                                                                                                                                                                                                                                                            touches: undefined | TouchList;
                                                                                                                                                                                                                                                                                                                                                                                            type: string;
                                                                                                                                                                                                                                                                                                                                                                                            view: Window;
                                                                                                                                                                                                                                                                                                                                                                                            which: undefined | number;
                                                                                                                                                                                                                                                                                                                                                                                            isDefaultPrevented(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                            isImmediatePropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                            isPropagationStopped(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                            preventDefault(): void;
                                                                                                                                                                                                                                                                                                                                                                                            stopImmediatePropagation(): void;
                                                                                                                                                                                                                                                                                                                                                                                            stopPropagation(): void;
                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                        • TDelegateTarget = any
                                                                                                                                                                                                                                                                                                                                                                                        • TData = any
                                                                                                                                                                                                                                                                                                                                                                                        • TCurrentTarget = any
                                                                                                                                                                                                                                                                                                                                                                                        • TTarget = any

                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                        altKey +bubbles +button +buttons +cancelable +changedTouches +char +charCode +clientX +clientY +ctrlKey +currentTarget +data +delegateTarget +detail +eventPhase +key +keyCode +metaKey +namespace? +offsetX +offsetY +originalEvent? +pageX +pageY +pointerId +pointerType +result? +screenX +screenY +shiftKey +target +targetTouches +timeStamp +toElement +touches +type +view +which +

                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                        isDefaultPrevented +isImmediatePropagationStopped +isPropagationStopped +preventDefault +stopImmediatePropagation +stopPropagation +

                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                        altKey: undefined | boolean
                                                                                                                                                                                                                                                                                                                                                                                        bubbles: boolean
                                                                                                                                                                                                                                                                                                                                                                                        button: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                        buttons: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                        cancelable: boolean
                                                                                                                                                                                                                                                                                                                                                                                        changedTouches: undefined | TouchList
                                                                                                                                                                                                                                                                                                                                                                                        char: undefined | string
                                                                                                                                                                                                                                                                                                                                                                                        charCode: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                        clientX: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                        clientY: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                        ctrlKey: undefined | boolean
                                                                                                                                                                                                                                                                                                                                                                                        currentTarget: TCurrentTarget

                                                                                                                                                                                                                                                                                                                                                                                        The current DOM element within the event bubbling phase.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.currentTarget/">https://api.jquery.com/event.currentTarget/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.3

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Alert that currentTarget matches the `this` keyword.

                                                                                                                                                                                                                                                                                                                                                                                        $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        alert( event.currentTarget === this ); // true
                                                                                                                                                                                                                                                                                                                                                                                        });
+
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        data: TData

                                                                                                                                                                                                                                                                                                                                                                                        An optional object of data passed to an event method when the current executing handler is bound.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.data/">https://api.jquery.com/event.data/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.1

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Within a for loop, pass the value of i to the .on() method so that the current iteration&#39;s value is preserved.

                                                                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                        <title>event.data demo</title>
                                                                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <button> 0 </button>
                                                                                                                                                                                                                                                                                                                                                                                        <button> 1 </button>
                                                                                                                                                                                                                                                                                                                                                                                        <button> 2 </button>
                                                                                                                                                                                                                                                                                                                                                                                        <button> 3 </button>
                                                                                                                                                                                                                                                                                                                                                                                        <button> 4 </button>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                                                                        var logDiv = $( "#log" );
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        for ( var i = 0; i < 5; i++ ) {
                                                                                                                                                                                                                                                                                                                                                                                        $( "button" ).eq( i ).on( "click", { value: i }, function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        var msgs = [
                                                                                                                                                                                                                                                                                                                                                                                        "button = " + $( this ).index(),
                                                                                                                                                                                                                                                                                                                                                                                        "event.data.value = " + event.data.value,
                                                                                                                                                                                                                                                                                                                                                                                        "i = " + i
                                                                                                                                                                                                                                                                                                                                                                                        ];
                                                                                                                                                                                                                                                                                                                                                                                        logDiv.append( msgs.join( ", " ) + "<br>" );
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        delegateTarget: TDelegateTarget

                                                                                                                                                                                                                                                                                                                                                                                        The element where the currently-called jQuery event handler was attached.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.delegateTarget/">https://api.jquery.com/event.delegateTarget/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.7

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````When a button in any box class is clicked, change the box&#39;s background color to red.

                                                                                                                                                                                                                                                                                                                                                                                        $( ".box" ).on( "click", "button", function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        $( event.delegateTarget ).css( "background-color", "red" );
                                                                                                                                                                                                                                                                                                                                                                                        });
+
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        detail: number
                                                                                                                                                                                                                                                                                                                                                                                        eventPhase: number
                                                                                                                                                                                                                                                                                                                                                                                        key: undefined | string
                                                                                                                                                                                                                                                                                                                                                                                        keyCode: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                        metaKey: undefined | boolean

                                                                                                                                                                                                                                                                                                                                                                                        Indicates whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.metaKey/">https://api.jquery.com/event.metaKey/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.0.4

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Determine whether the META key was pressed when the event fired.

                                                                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                        <title>event.metaKey demo</title>
                                                                                                                                                                                                                                                                                                                                                                                        <style>
                                                                                                                                                                                                                                                                                                                                                                                        body {
                                                                                                                                                                                                                                                                                                                                                                                        background-color: #eef;
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        div {
                                                                                                                                                                                                                                                                                                                                                                                        padding: 20px;
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        </style>
                                                                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <button value="Test" name="Test" id="checkMetaKey">Click me!</button>
                                                                                                                                                                                                                                                                                                                                                                                        <div id="display"></div>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                                                                        $( "#checkMetaKey" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        $( "#display" ).text( event.metaKey );
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        namespace?: string

                                                                                                                                                                                                                                                                                                                                                                                        The namespace specified when the event was triggered.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.namespace/">https://api.jquery.com/event.namespace/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.4.3

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Determine the event namespace used.

                                                                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                        <title>event.namespace demo</title>
                                                                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <button>display event.namespace</button>
                                                                                                                                                                                                                                                                                                                                                                                        <p></p>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                                                                        $( "p" ).on( "test.something", function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        alert( event.namespace );
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        $( "p" ).trigger( "test.something" );
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        offsetX: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                        offsetY: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                        originalEvent?: UIEvent
                                                                                                                                                                                                                                                                                                                                                                                        pageX: undefined | number

                                                                                                                                                                                                                                                                                                                                                                                        The mouse position relative to the left edge of the document.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.pageX/">https://api.jquery.com/event.pageX/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.0.4

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe).

                                                                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                        <title>event.pageX demo</title>
                                                                                                                                                                                                                                                                                                                                                                                        <style>
                                                                                                                                                                                                                                                                                                                                                                                        body {
                                                                                                                                                                                                                                                                                                                                                                                        background-color: #eef;
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        div {
                                                                                                                                                                                                                                                                                                                                                                                        padding: 20px;
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        </style>
                                                                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                                                                        $( document ).on( "mousemove", function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        $( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        pageY: undefined | number

                                                                                                                                                                                                                                                                                                                                                                                        The mouse position relative to the top edge of the document.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.pageY/">https://api.jquery.com/event.pageY/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.0.4

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe).

                                                                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                        <title>event.pageY demo</title>
                                                                                                                                                                                                                                                                                                                                                                                        <style>
                                                                                                                                                                                                                                                                                                                                                                                        body {
                                                                                                                                                                                                                                                                                                                                                                                        background-color: #eef;
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        div {
                                                                                                                                                                                                                                                                                                                                                                                        padding: 20px;
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        </style>
                                                                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                                                                        $( document ).on( "mousemove", function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        $( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        pointerId: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                        pointerType: undefined | string
                                                                                                                                                                                                                                                                                                                                                                                        result?: any

                                                                                                                                                                                                                                                                                                                                                                                        The last value returned by an event handler that was triggered by this event, unless the value was undefined.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.result/">https://api.jquery.com/event.result/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.3

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Display previous handler&#39;s return value

                                                                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                        <title>event.result demo</title>
                                                                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <button>display event.result</button>
                                                                                                                                                                                                                                                                                                                                                                                        <p></p>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                                                                        $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        return "hey";
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        $( "p" ).html( event.result );
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        screenX: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                        screenY: undefined | number
                                                                                                                                                                                                                                                                                                                                                                                        shiftKey: undefined | boolean
                                                                                                                                                                                                                                                                                                                                                                                        target: TTarget

                                                                                                                                                                                                                                                                                                                                                                                        The DOM element that initiated the event.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.target/">https://api.jquery.com/event.target/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.0

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Display the tag&#39;s name on click +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>event.target demo</title> +<style> +span, strong, p { +padding: 8px; +display: block; +border: 1px solid #999; +} +</style> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<div id="log"></div> +<div> +<p> +<strong><span>click</span></strong> +</p> +</div> +​ +<script> +$( "body" ).click(function( event ) { +$( "#log" ).html( "clicked: " + event.target.nodeName ); +}); +</script> +​ +</body> +</html> +``` +@example ​ ````Implements a simple event delegation: The click handler is added to an unordered list, and the children of its li children are hidden. Clicking one of the li children toggles (see toggle()) their children.

                                                                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                        <title>event.target demo</title>
                                                                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <ul>
                                                                                                                                                                                                                                                                                                                                                                                        <li>item 1
                                                                                                                                                                                                                                                                                                                                                                                        <ul>
                                                                                                                                                                                                                                                                                                                                                                                        <li>sub item 1-a</li>
                                                                                                                                                                                                                                                                                                                                                                                        <li>sub item 1-b</li>
                                                                                                                                                                                                                                                                                                                                                                                        </ul>
                                                                                                                                                                                                                                                                                                                                                                                        </li>
                                                                                                                                                                                                                                                                                                                                                                                        <li>item 2
                                                                                                                                                                                                                                                                                                                                                                                        <ul>
                                                                                                                                                                                                                                                                                                                                                                                        <li>sub item 2-a</li>
                                                                                                                                                                                                                                                                                                                                                                                        <li>sub item 2-b</li>
                                                                                                                                                                                                                                                                                                                                                                                        </ul>
                                                                                                                                                                                                                                                                                                                                                                                        </li>
                                                                                                                                                                                                                                                                                                                                                                                        </ul>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                                                                        function handler( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        var target = $( event.target );
                                                                                                                                                                                                                                                                                                                                                                                        if ( target.is( "li" ) ) {
                                                                                                                                                                                                                                                                                                                                                                                        target.children().toggle();
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        $( "ul" ).click( handler ).find( "ul" ).hide();
                                                                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        targetTouches: undefined | TouchList
                                                                                                                                                                                                                                                                                                                                                                                        timeStamp: number

                                                                                                                                                                                                                                                                                                                                                                                        The difference in milliseconds between the time the browser created the event and January 1, 1970.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.timeStamp/">https://api.jquery.com/event.timeStamp/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.2.6

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Display the time since the click handler last executed.

                                                                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                        <title>event.timeStamp demo</title>
                                                                                                                                                                                                                                                                                                                                                                                        <style>
                                                                                                                                                                                                                                                                                                                                                                                        div {
                                                                                                                                                                                                                                                                                                                                                                                        height: 100px;
                                                                                                                                                                                                                                                                                                                                                                                        width: 300px;
                                                                                                                                                                                                                                                                                                                                                                                        margin: 10px;
                                                                                                                                                                                                                                                                                                                                                                                        background-color: #ffd;
                                                                                                                                                                                                                                                                                                                                                                                        overflow: auto;
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        </style>
                                                                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <div>Click.</div>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                                                                        var last, diff;
                                                                                                                                                                                                                                                                                                                                                                                        $( "div" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        if ( last ) {
                                                                                                                                                                                                                                                                                                                                                                                        diff = event.timeStamp - last;
                                                                                                                                                                                                                                                                                                                                                                                        $( "div" ).append( "time since last event: " + diff + "<br>" );
                                                                                                                                                                                                                                                                                                                                                                                        } else {
                                                                                                                                                                                                                                                                                                                                                                                        $( "div" ).append( "Click again.<br>" );
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        last = event.timeStamp;
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        toElement: undefined | Element
                                                                                                                                                                                                                                                                                                                                                                                        touches: undefined | TouchList
                                                                                                                                                                                                                                                                                                                                                                                        type: string

                                                                                                                                                                                                                                                                                                                                                                                        Describes the nature of the event.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.type/">https://api.jquery.com/event.type/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.0

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````On all anchor clicks, alert the event type.

                                                                                                                                                                                                                                                                                                                                                                                        $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        alert( event.type ); // "click"
                                                                                                                                                                                                                                                                                                                                                                                        });
+
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        view: Window
                                                                                                                                                                                                                                                                                                                                                                                        which: undefined | number

                                                                                                                                                                                                                                                                                                                                                                                        For key or mouse events, this property indicates the specific key or button that was pressed.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        <a href="https://api.jquery.com/event.which/">https://api.jquery.com/event.which/</a>

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        1.1.3

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Example: ​ ````Log which key was depressed. +```html +<!doctype html> +<html lang="en"> +<head> +<meta charset="utf-8"> +<title>event.which demo</title> +<script src="https://code.jquery.com/jquery-3.3.1.js"></script> +</head> +<body> +​ +<input id="whichkey" value="type something"> +<div id="log"></div> +​ +<script> +$( "#whichkey" ).on( "keydown", function( event ) { +$( "#log" ).html( event.type + ": " + event.which ); +}); +</script> +​ +</body> +</html> +``` +@example ​ ````Log which mouse button was depressed.

                                                                                                                                                                                                                                                                                                                                                                                        <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                        <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                        <head>
                                                                                                                                                                                                                                                                                                                                                                                        <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                        <title>event.which demo</title>
                                                                                                                                                                                                                                                                                                                                                                                        <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                        </head>
                                                                                                                                                                                                                                                                                                                                                                                        <body>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <input id="whichkey" value="click here">
                                                                                                                                                                                                                                                                                                                                                                                        <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        <script>
                                                                                                                                                                                                                                                                                                                                                                                        $( "#whichkey" ).on( "mousedown", function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                        $( "#log" ).html( event.type + ": " +  event.which );
                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                        </script>
                                                                                                                                                                                                                                                                                                                                                                                        ​
                                                                                                                                                                                                                                                                                                                                                                                        </body>
                                                                                                                                                                                                                                                                                                                                                                                        </html>
+
                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                        • Returns whether event.preventDefault() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.isDefaultPrevented/">https://api.jquery.com/event.isDefaultPrevented/</a>

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          1.3

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Checks whether event.preventDefault() was called.

                                                                                                                                                                                                                                                                                                                                                                                          $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                          alert( event.isDefaultPrevented() ); // false
                                                                                                                                                                                                                                                                                                                                                                                          event.preventDefault();
                                                                                                                                                                                                                                                                                                                                                                                          alert( event.isDefaultPrevented() ); // true
                                                                                                                                                                                                                                                                                                                                                                                          });
+
                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                        • Returns whether event.stopImmediatePropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.isImmediatePropagationStopped/">https://api.jquery.com/event.isImmediatePropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          1.3

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Checks whether event.stopImmediatePropagation() was called.

                                                                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                          <title>event.isImmediatePropagationStopped demo</title>
                                                                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                                                                          <button>click me</button>
                                                                                                                                                                                                                                                                                                                                                                                          <div id="stop-log"></div>
                                                                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                                                                          function immediatePropStopped( event ) {
                                                                                                                                                                                                                                                                                                                                                                                          var msg = "";
                                                                                                                                                                                                                                                                                                                                                                                          if ( event.isImmediatePropagationStopped() ) {
                                                                                                                                                                                                                                                                                                                                                                                          msg = "called";
                                                                                                                                                                                                                                                                                                                                                                                          } else {
                                                                                                                                                                                                                                                                                                                                                                                          msg = "not called";
                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                          $( "#stop-log" ).append( "<div>" + msg + "</div>" );
                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                                                                          $( "button" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                          immediatePropStopped( event );
                                                                                                                                                                                                                                                                                                                                                                                          event.stopImmediatePropagation();
                                                                                                                                                                                                                                                                                                                                                                                          immediatePropStopped( event );
                                                                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                        • Returns whether event.stopPropagation() was ever called on this event object.

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.isPropagationStopped/">https://api.jquery.com/event.isPropagationStopped/</a>

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          1.3

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Checks whether event.stopPropagation() was called

                                                                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                          <title>event.isPropagationStopped demo</title>
                                                                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                                                                          <button>click me</button>
                                                                                                                                                                                                                                                                                                                                                                                          <div id="stop-log"></div>
                                                                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                                                                          function propStopped( event ) {
                                                                                                                                                                                                                                                                                                                                                                                          var msg = "";
                                                                                                                                                                                                                                                                                                                                                                                          if ( event.isPropagationStopped() ) {
                                                                                                                                                                                                                                                                                                                                                                                          msg = "called";
                                                                                                                                                                                                                                                                                                                                                                                          } else {
                                                                                                                                                                                                                                                                                                                                                                                          msg = "not called";
                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                          $( "#stop-log" ).append( "<div>" + msg + "</div>" );
                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                                                                          $( "button" ).click(function(event) {
                                                                                                                                                                                                                                                                                                                                                                                          propStopped( event );
                                                                                                                                                                                                                                                                                                                                                                                          event.stopPropagation();
                                                                                                                                                                                                                                                                                                                                                                                          propStopped( event );
                                                                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                        • If this method is called, the default action of the event will not be triggered.

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.preventDefault/">https://api.jquery.com/event.preventDefault/</a>

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          1.0

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Cancel the default action (navigation) of the click.

                                                                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                          <title>event.preventDefault demo</title>
                                                                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                                                                          <a href="https://jquery.com">default click action is prevented</a>
                                                                                                                                                                                                                                                                                                                                                                                          <div id="log"></div>
                                                                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                                                                          $( "a" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                          event.preventDefault();
                                                                                                                                                                                                                                                                                                                                                                                          $( "<div>" )
                                                                                                                                                                                                                                                                                                                                                                                          .append( "default " + event.type + " prevented" )
                                                                                                                                                                                                                                                                                                                                                                                          .appendTo( "#log" );
                                                                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                        • Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.stopImmediatePropagation/">https://api.jquery.com/event.stopImmediatePropagation/</a>

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          1.3

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Prevents other event handlers from being called.

                                                                                                                                                                                                                                                                                                                                                                                          <!doctype html>
                                                                                                                                                                                                                                                                                                                                                                                          <html lang="en">
                                                                                                                                                                                                                                                                                                                                                                                          <head>
                                                                                                                                                                                                                                                                                                                                                                                          <meta charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                          <title>event.stopImmediatePropagation demo</title>
                                                                                                                                                                                                                                                                                                                                                                                          <style>
                                                                                                                                                                                                                                                                                                                                                                                          p {
                                                                                                                                                                                                                                                                                                                                                                                          height: 30px;
                                                                                                                                                                                                                                                                                                                                                                                          width: 150px;
                                                                                                                                                                                                                                                                                                                                                                                          background-color: #ccf;
                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                          div {
                                                                                                                                                                                                                                                                                                                                                                                          height: 30px;
                                                                                                                                                                                                                                                                                                                                                                                          width: 150px;
                                                                                                                                                                                                                                                                                                                                                                                          background-color: #cfc;
                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                          </style>
                                                                                                                                                                                                                                                                                                                                                                                          <script src="https://code.jquery.com/jquery-3.3.1.js"></script>
                                                                                                                                                                                                                                                                                                                                                                                          </head>
                                                                                                                                                                                                                                                                                                                                                                                          <body>
                                                                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                                                                          <p>paragraph</p>
                                                                                                                                                                                                                                                                                                                                                                                          <div>division</div>
                                                                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                                                                          <script>
                                                                                                                                                                                                                                                                                                                                                                                          $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                          event.stopImmediatePropagation();
                                                                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                                                                          $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                          // This function won't be executed
                                                                                                                                                                                                                                                                                                                                                                                          $( this ).css( "background-color", "#f00" );
                                                                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                                                                          $( "div" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                          // This function will be executed
                                                                                                                                                                                                                                                                                                                                                                                          $( this ).css( "background-color", "#f00" );
                                                                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                                                                          </script>
                                                                                                                                                                                                                                                                                                                                                                                          ​
                                                                                                                                                                                                                                                                                                                                                                                          </body>
                                                                                                                                                                                                                                                                                                                                                                                          </html>
+
                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                        • Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                          <a href="https://api.jquery.com/event.stopPropagation/">https://api.jquery.com/event.stopPropagation/</a>

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          1.0

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Example: ​ ````Kill the bubbling on the click event.

                                                                                                                                                                                                                                                                                                                                                                                          $( "p" ).click(function( event ) {
                                                                                                                                                                                                                                                                                                                                                                                          event.stopPropagation();
                                                                                                                                                                                                                                                                                                                                                                                          // Do something
                                                                                                                                                                                                                                                                                                                                                                                          });
+
                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.ViewScope.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ViewScope.html new file mode 100644 index 000000000..a38044d3b --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.ViewScope.html @@ -0,0 +1,14 @@ +ViewScope | trilium
                                                                                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                          Interface ViewScope

                                                                                                                                                                                                                                                                                                                                                                                          interface ViewScope {
                                                                                                                                                                                                                                                                                                                                                                                              attachmentId?: string;
                                                                                                                                                                                                                                                                                                                                                                                              highlightsListPreviousVisible?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              highlightsListTemporarilyHidden?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              readOnlyTemporarilyDisabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              tocPreviousVisible?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              tocTemporarilyHidden?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              viewMode?: string;
                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                          attachmentId? +highlightsListPreviousVisible? +highlightsListTemporarilyHidden? +readOnlyTemporarilyDisabled? +tocPreviousVisible? +tocTemporarilyHidden? +viewMode? +

                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                          attachmentId?: string
                                                                                                                                                                                                                                                                                                                                                                                          highlightsListPreviousVisible?: boolean
                                                                                                                                                                                                                                                                                                                                                                                          highlightsListTemporarilyHidden?: boolean
                                                                                                                                                                                                                                                                                                                                                                                          readOnlyTemporarilyDisabled?: boolean
                                                                                                                                                                                                                                                                                                                                                                                          tocPreviousVisible?: boolean
                                                                                                                                                                                                                                                                                                                                                                                          tocTemporarilyHidden?: boolean
                                                                                                                                                                                                                                                                                                                                                                                          viewMode?: string
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                          • "source", when viewing the source code of a note.
                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                          • "attachments", when viewing the attachments of a note.
                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                          • "contextual-help", if the current view represents a help window that was opened to the side of the main content.
                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                          • "default", otherwise.
                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/interfaces/Frontend_Script_API._internal_.Writer.html b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Writer.html new file mode 100644 index 000000000..5a24afd5a --- /dev/null +++ b/docs/backend_api/interfaces/Frontend_Script_API._internal_.Writer.html @@ -0,0 +1,9 @@ +Writer | trilium
                                                                                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                            Interface Writer

                                                                                                                                                                                                                                                                                                                                                                                            interface Writer {
                                                                                                                                                                                                                                                                                                                                                                                                addMarker(
                                                                                                                                                                                                                                                                                                                                                                                                    name: string,
                                                                                                                                                                                                                                                                                                                                                                                                    opts: { range: Range; usingOperation: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                ): any;
                                                                                                                                                                                                                                                                                                                                                                                                createElement(
                                                                                                                                                                                                                                                                                                                                                                                                    type: string,
                                                                                                                                                                                                                                                                                                                                                                                                    opts: Record<string, undefined | null | string>,
                                                                                                                                                                                                                                                                                                                                                                                                ): any;
                                                                                                                                                                                                                                                                                                                                                                                                createPositionAt(el: CKNode, opt?: number | "end"): any;
                                                                                                                                                                                                                                                                                                                                                                                                createRange(start: number, end: number): Range;
                                                                                                                                                                                                                                                                                                                                                                                                insertText(
                                                                                                                                                                                                                                                                                                                                                                                                    text: string,
                                                                                                                                                                                                                                                                                                                                                                                                    opts: undefined | Record<string, unknown> | TextPosition,
                                                                                                                                                                                                                                                                                                                                                                                                    position?: TextPosition,
                                                                                                                                                                                                                                                                                                                                                                                                ): any;
                                                                                                                                                                                                                                                                                                                                                                                                removeMarker(name: string): any;
                                                                                                                                                                                                                                                                                                                                                                                                setAttribute(name: string, value: string, el: CKNode): any;
                                                                                                                                                                                                                                                                                                                                                                                                setSelection(pos: number, pos?: number): any;
                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                            addMarker +createElement +createPositionAt +createRange +insertText +removeMarker +setAttribute +setSelection +

                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • name: string
                                                                                                                                                                                                                                                                                                                                                                                              • opts: { range: Range; usingOperation: boolean }

                                                                                                                                                                                                                                                                                                                                                                                              Returns any

                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • type: string
                                                                                                                                                                                                                                                                                                                                                                                              • opts: Record<string, undefined | null | string>

                                                                                                                                                                                                                                                                                                                                                                                              Returns any

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/modules.html b/docs/backend_api/modules.html index 41e5f0349..304f9c960 100644 --- a/docs/backend_api/modules.html +++ b/docs/backend_api/modules.html @@ -1 +1 @@ -trilium
                                                                                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                trilium

                                                                                                                                                                                                                                                                                                                                                                                                Modules

                                                                                                                                                                                                                                                                                                                                                                                                Backend Script API

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                Modules
                                                                                                                                                                                                                                                                                                                                                                                                +trilium
                                                                                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                    trilium

                                                                                                                                                                                                                                                                                                                                                                                                    Modules

                                                                                                                                                                                                                                                                                                                                                                                                    Backend Script API
                                                                                                                                                                                                                                                                                                                                                                                                    Frontend Script API

                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                    Modules
                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/modules/Frontend_Script_API._internal_.html b/docs/backend_api/modules/Frontend_Script_API._internal_.html new file mode 100644 index 000000000..ec53d4ed4 --- /dev/null +++ b/docs/backend_api/modules/Frontend_Script_API._internal_.html @@ -0,0 +1 @@ +<internal> | trilium
                                                                                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                      Module <internal>

                                                                                                                                                                                                                                                                                                                                                                                                      Enumerations

                                                                                                                                                                                                                                                                                                                                                                                                      FancytreeClickFolderMode
                                                                                                                                                                                                                                                                                                                                                                                                      FancytreeSelectMode

                                                                                                                                                                                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                                                                                                                                                                                      default
                                                                                                                                                                                                                                                                                                                                                                                                      default
                                                                                                                                                                                                                                                                                                                                                                                                      default
                                                                                                                                                                                                                                                                                                                                                                                                      default
                                                                                                                                                                                                                                                                                                                                                                                                      default
                                                                                                                                                                                                                                                                                                                                                                                                      default
                                                                                                                                                                                                                                                                                                                                                                                                      default
                                                                                                                                                                                                                                                                                                                                                                                                      default
                                                                                                                                                                                                                                                                                                                                                                                                      default
                                                                                                                                                                                                                                                                                                                                                                                                      FAttachment
                                                                                                                                                                                                                                                                                                                                                                                                      FAttribute
                                                                                                                                                                                                                                                                                                                                                                                                      FBranch
                                                                                                                                                                                                                                                                                                                                                                                                      FNote
                                                                                                                                                                                                                                                                                                                                                                                                      NoteContext
                                                                                                                                                                                                                                                                                                                                                                                                      NoteContextAwareWidget
                                                                                                                                                                                                                                                                                                                                                                                                      RightPanelWidget
                                                                                                                                                                                                                                                                                                                                                                                                      TypedComponent

                                                                                                                                                                                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                      AddToToolbarOpts
                                                                                                                                                                                                                                                                                                                                                                                                      Attribute
                                                                                                                                                                                                                                                                                                                                                                                                      BaseJQueryEventObject
                                                                                                                                                                                                                                                                                                                                                                                                      CKEvent
                                                                                                                                                                                                                                                                                                                                                                                                      CKNode
                                                                                                                                                                                                                                                                                                                                                                                                      CodeMirrorInstance
                                                                                                                                                                                                                                                                                                                                                                                                      CommandData
                                                                                                                                                                                                                                                                                                                                                                                                      ConfirmDialogOptions
                                                                                                                                                                                                                                                                                                                                                                                                      ConfirmWithMessageOptions
                                                                                                                                                                                                                                                                                                                                                                                                      ConfirmWithTitleOptions
                                                                                                                                                                                                                                                                                                                                                                                                      ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                      CreateLinkOptions
                                                                                                                                                                                                                                                                                                                                                                                                      DefinitionObject
                                                                                                                                                                                                                                                                                                                                                                                                      DragAndDrop5
                                                                                                                                                                                                                                                                                                                                                                                                      Event
                                                                                                                                                                                                                                                                                                                                                                                                      EventData
                                                                                                                                                                                                                                                                                                                                                                                                      ExecuteCommandData
                                                                                                                                                                                                                                                                                                                                                                                                      Fancytree
                                                                                                                                                                                                                                                                                                                                                                                                      FancytreeEvents
                                                                                                                                                                                                                                                                                                                                                                                                      FancytreeNode
                                                                                                                                                                                                                                                                                                                                                                                                      FancytreeOptions
                                                                                                                                                                                                                                                                                                                                                                                                      FAttachmentRow
                                                                                                                                                                                                                                                                                                                                                                                                      FAttributeRow
                                                                                                                                                                                                                                                                                                                                                                                                      FBranchRow
                                                                                                                                                                                                                                                                                                                                                                                                      Filter
                                                                                                                                                                                                                                                                                                                                                                                                      FNoteRow
                                                                                                                                                                                                                                                                                                                                                                                                      Froca
                                                                                                                                                                                                                                                                                                                                                                                                      JQueryEventObject
                                                                                                                                                                                                                                                                                                                                                                                                      JQueryInputEventObject
                                                                                                                                                                                                                                                                                                                                                                                                      JQueryKeyEventObject
                                                                                                                                                                                                                                                                                                                                                                                                      JQueryMouseEventObject
                                                                                                                                                                                                                                                                                                                                                                                                      JQueryPromise
                                                                                                                                                                                                                                                                                                                                                                                                      List
                                                                                                                                                                                                                                                                                                                                                                                                      Marker
                                                                                                                                                                                                                                                                                                                                                                                                      MentionConfig
                                                                                                                                                                                                                                                                                                                                                                                                      MentionItem
                                                                                                                                                                                                                                                                                                                                                                                                      MouseDownEvent
                                                                                                                                                                                                                                                                                                                                                                                                      MouseEventBase
                                                                                                                                                                                                                                                                                                                                                                                                      NodeData
                                                                                                                                                                                                                                                                                                                                                                                                      NodePatch
                                                                                                                                                                                                                                                                                                                                                                                                      NoteCommandData
                                                                                                                                                                                                                                                                                                                                                                                                      NoteMetaData
                                                                                                                                                                                                                                                                                                                                                                                                      NotePathRecord
                                                                                                                                                                                                                                                                                                                                                                                                      NoteSwitchedContext
                                                                                                                                                                                                                                                                                                                                                                                                      PersistData
                                                                                                                                                                                                                                                                                                                                                                                                      Promise
                                                                                                                                                                                                                                                                                                                                                                                                      PromiseBase
                                                                                                                                                                                                                                                                                                                                                                                                      PromiseLike
                                                                                                                                                                                                                                                                                                                                                                                                      PromptDialogOptions
                                                                                                                                                                                                                                                                                                                                                                                                      ResolveOptions
                                                                                                                                                                                                                                                                                                                                                                                                      SetNoteOpts
                                                                                                                                                                                                                                                                                                                                                                                                      ShownCallbackData
                                                                                                                                                                                                                                                                                                                                                                                                      Table
                                                                                                                                                                                                                                                                                                                                                                                                      TextEditor
                                                                                                                                                                                                                                                                                                                                                                                                      TextNode
                                                                                                                                                                                                                                                                                                                                                                                                      TextPosition
                                                                                                                                                                                                                                                                                                                                                                                                      TextRange
                                                                                                                                                                                                                                                                                                                                                                                                      Thenable
                                                                                                                                                                                                                                                                                                                                                                                                      TranslationTable
                                                                                                                                                                                                                                                                                                                                                                                                      TriggeredEvent
                                                                                                                                                                                                                                                                                                                                                                                                      UIEventBase
                                                                                                                                                                                                                                                                                                                                                                                                      ViewScope
                                                                                                                                                                                                                                                                                                                                                                                                      Writer

                                                                                                                                                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                      AttributeType
                                                                                                                                                                                                                                                                                                                                                                                                      CallbackBase
                                                                                                                                                                                                                                                                                                                                                                                                      CommandAndEventMappings
                                                                                                                                                                                                                                                                                                                                                                                                      CommandMappings
                                                                                                                                                                                                                                                                                                                                                                                                      CommandNames
                                                                                                                                                                                                                                                                                                                                                                                                      ConfirmDialogCallback
                                                                                                                                                                                                                                                                                                                                                                                                      ConfirmDialogResult
                                                                                                                                                                                                                                                                                                                                                                                                      ElementType
                                                                                                                                                                                                                                                                                                                                                                                                      EventData
                                                                                                                                                                                                                                                                                                                                                                                                      EventListener
                                                                                                                                                                                                                                                                                                                                                                                                      EventMappings
                                                                                                                                                                                                                                                                                                                                                                                                      EventNames
                                                                                                                                                                                                                                                                                                                                                                                                      EventOnlyNames
                                                                                                                                                                                                                                                                                                                                                                                                      Func
                                                                                                                                                                                                                                                                                                                                                                                                      GetTextEditorCallback
                                                                                                                                                                                                                                                                                                                                                                                                      Handler
                                                                                                                                                                                                                                                                                                                                                                                                      LabelType
                                                                                                                                                                                                                                                                                                                                                                                                      Multiplicity
                                                                                                                                                                                                                                                                                                                                                                                                      NoteType
                                                                                                                                                                                                                                                                                                                                                                                                      PromptShownDialogCallback
                                                                                                                                                                                                                                                                                                                                                                                                      Required
                                                                                                                                                                                                                                                                                                                                                                                                      Screen
                                                                                                                                                                                                                                                                                                                                                                                                      SqlExecuteResults
                                                                                                                                                                                                                                                                                                                                                                                                      TypeOrArray

                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                      Enumerations
                                                                                                                                                                                                                                                                                                                                                                                                      Classes
                                                                                                                                                                                                                                                                                                                                                                                                      Interfaces
                                                                                                                                                                                                                                                                                                                                                                                                      AddToToolbarOptsAttributeBaseJQueryEventObjectCKEventCKNodeCodeMirrorInstanceCommandDataConfirmDialogOptionsConfirmWithMessageOptionsConfirmWithTitleOptionsContextMenuCommandDataCreateLinkOptionsDefinitionObjectDragAndDrop5EventEventDataExecuteCommandDataFancytreeFancytreeEventsFancytreeNodeFancytreeOptionsFAttachmentRowFAttributeRowFBranchRowFilterFNoteRowFrocaJQueryEventObjectJQueryInputEventObjectJQueryKeyEventObjectJQueryMouseEventObjectJQueryPromiseListMarkerMentionConfigMentionItemMouseDownEventMouseEventBaseNodeDataNodePatchNoteCommandDataNoteMetaDataNotePathRecordNoteSwitchedContextPersistDataPromisePromiseBasePromiseLikePromptDialogOptionsResolveOptionsSetNoteOptsShownCallbackDataTableTextEditorTextNodeTextPositionTextRangeThenableTranslationTableTriggeredEventUIEventBaseViewScopeWriter
                                                                                                                                                                                                                                                                                                                                                                                                      Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/modules/Frontend_Script_API.html b/docs/backend_api/modules/Frontend_Script_API.html new file mode 100644 index 000000000..e74dcb9b9 --- /dev/null +++ b/docs/backend_api/modules/Frontend_Script_API.html @@ -0,0 +1,3 @@ +Frontend Script API | trilium
                                                                                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                        Module Frontend Script API

                                                                                                                                                                                                                                                                                                                                                                                                        The front script API is accessible to code notes with the "JS (frontend)" language.

                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        All the variables listed are globally accessible to the script.

                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        Modules

                                                                                                                                                                                                                                                                                                                                                                                                        <internal>

                                                                                                                                                                                                                                                                                                                                                                                                        Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                        Api

                                                                                                                                                                                                                                                                                                                                                                                                        Variables

                                                                                                                                                                                                                                                                                                                                                                                                        api

                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                        Modules
                                                                                                                                                                                                                                                                                                                                                                                                        Interfaces
                                                                                                                                                                                                                                                                                                                                                                                                        Variables
                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/types/Backend_Script_API._internal_.AttributeType.html b/docs/backend_api/types/Backend_Script_API._internal_.AttributeType.html index 18fe98963..702124da6 100644 --- a/docs/backend_api/types/Backend_Script_API._internal_.AttributeType.html +++ b/docs/backend_api/types/Backend_Script_API._internal_.AttributeType.html @@ -1 +1 @@ -AttributeType | trilium
                                                                                                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias AttributeType

                                                                                                                                                                                                                                                                                                                                                                                                          AttributeType: "label" | "relation" | "label-definition" | "relation-definition"

                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                          +AttributeType | trilium
                                                                                                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias AttributeType

                                                                                                                                                                                                                                                                                                                                                                                                            AttributeType: "label" | "relation" | "label-definition" | "relation-definition"

                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/types/Backend_Script_API._internal_.Updater.html b/docs/backend_api/types/Backend_Script_API._internal_.Updater.html index 3bd8a6b6c..423b42898 100644 --- a/docs/backend_api/types/Backend_Script_API._internal_.Updater.html +++ b/docs/backend_api/types/Backend_Script_API._internal_.Updater.html @@ -1 +1 @@ -Updater | trilium
                                                                                                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Updater

                                                                                                                                                                                                                                                                                                                                                                                                              Updater: () => void

                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                • (): void

                                                                                                                                                                                                                                                                                                                                                                                                                • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                              +Updater | trilium
                                                                                                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Updater

                                                                                                                                                                                                                                                                                                                                                                                                                Updater: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                  • (): void

                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.AttributeType.html b/docs/backend_api/types/Frontend_Script_API._internal_.AttributeType.html new file mode 100644 index 000000000..f3184eea9 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.AttributeType.html @@ -0,0 +1,2 @@ +AttributeType | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias AttributeType

                                                                                                                                                                                                                                                                                                                                                                                                                  AttributeType: "label" | "relation"

                                                                                                                                                                                                                                                                                                                                                                                                                  There are currently only two types of attributes, labels or relations.

                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.CallbackBase.html b/docs/backend_api/types/Frontend_Script_API._internal_.CallbackBase.html new file mode 100644 index 000000000..8aa70ed01 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.CallbackBase.html @@ -0,0 +1 @@ +CallbackBase | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias CallbackBase<T, U, V, R>

                                                                                                                                                                                                                                                                                                                                                                                                                    CallbackBase: (t: T, u: U, v: V, ...r: R[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                    • T
                                                                                                                                                                                                                                                                                                                                                                                                                    • U
                                                                                                                                                                                                                                                                                                                                                                                                                    • V
                                                                                                                                                                                                                                                                                                                                                                                                                    • R

                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                      • (t: T, u: U, v: V, ...r: R[]): void

                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                        • t: T
                                                                                                                                                                                                                                                                                                                                                                                                                        • u: U
                                                                                                                                                                                                                                                                                                                                                                                                                        • v: V
                                                                                                                                                                                                                                                                                                                                                                                                                        • ...r: R[]

                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.CommandAndEventMappings.html b/docs/backend_api/types/Frontend_Script_API._internal_.CommandAndEventMappings.html new file mode 100644 index 000000000..8e9863bb2 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.CommandAndEventMappings.html @@ -0,0 +1 @@ +CommandAndEventMappings | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias CommandAndEventMappings

                                                                                                                                                                                                                                                                                                                                                                                                                      CommandAndEventMappings: CommandMappings & EventMappings

                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.CommandMappings.html b/docs/backend_api/types/Frontend_Script_API._internal_.CommandMappings.html new file mode 100644 index 000000000..17280d4ab --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.CommandMappings.html @@ -0,0 +1,129 @@ +CommandMappings | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias CommandMappings

                                                                                                                                                                                                                                                                                                                                                                                                                        The keys represent the different commands that can be triggered via AppContext#triggerCommand (first argument), and the values represent the data or arguments definition of the given command. All data for commands must extend CommandData.

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        type CommandMappings = {
                                                                                                                                                                                                                                                                                                                                                                                                                            addNewLabel: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            addNewLabelDefinition: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            addNewRelation: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            addNewRelationDefinition: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            addNoteLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            addScriptLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            addSpacerLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            addTextToActiveEditor: CommandData & { text: string };
                                                                                                                                                                                                                                                                                                                                                                                                                            addWidgetLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            "api-log-messages": CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            cloneNoteIdsTo: CommandData & { noteIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                                                            cloneNotesTo: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            closeActiveTab: CommandData & { $el: JQuery<HTMLElement> };
                                                                                                                                                                                                                                                                                                                                                                                                                            closeAllTabs: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            closeHlt: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            closeOtherTabs: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            closeProtectedSessionPasswordDialog: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            closeRightTabs: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            closeTab: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            closeThisNoteSplit: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            closeToc: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            closeTocCommand: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            collapseSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            convertNoteToAttachment: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            copyImageReferenceToClipboard: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            copyImageToClipboard: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            copyNotePathToClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            copyNotesToClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            copyTabToNewWindow: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            cutNotesToClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            delete: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            deleteFromMap: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                            deleteNotes: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            duplicateSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            editBranchPrefix: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            editNoteTitle: {};
                                                                                                                                                                                                                                                                                                                                                                                                                            enterProtectedSession: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            executeInActiveNoteDetailWidget: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                                                                                callback: (value: default | PromiseLike<default>) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                            executeWithCodeEditor: CommandData & ExecuteCommandData<CodeMirrorInstance>;
                                                                                                                                                                                                                                                                                                                                                                                                                            executeWithContentElement: CommandData & ExecuteCommandData<
                                                                                                                                                                                                                                                                                                                                                                                                                                JQuery<HTMLElement>,
                                                                                                                                                                                                                                                                                                                                                                                                                            >;
                                                                                                                                                                                                                                                                                                                                                                                                                            executeWithTextEditor: CommandData & ExecuteCommandData<TextEditor> & {
                                                                                                                                                                                                                                                                                                                                                                                                                                callback?: GetTextEditorCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                            executeWithTypeWidget: CommandData & ExecuteCommandData<default | null>;
                                                                                                                                                                                                                                                                                                                                                                                                                            expandSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            exportNote: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            focusAndSelectTitle: CommandData & { isNewNote?: boolean };
                                                                                                                                                                                                                                                                                                                                                                                                                            focusOnDetail: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            focusOnSearchDefinition: Required<CommandData>;
                                                                                                                                                                                                                                                                                                                                                                                                                            focusOnTitle: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            focusTree: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            hideFloatingButtons: {};
                                                                                                                                                                                                                                                                                                                                                                                                                            hideLeftPane: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            hoistNote: CommandData & { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                            importIntoNote: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            importMarkdownInline: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            insertChildNote: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            insertNoteAfter: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            leaveProtectedSession: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            moveBranchIdsTo: CommandData & { branchIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                                                            moveLauncherToAvailable: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            moveLauncherToVisible: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            moveNoteDown: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            moveNoteDownInHierarchy: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            moveNotesTo: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            moveNoteUp: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            moveNoteUpInHierarchy: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            moveTabToNewWindow: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            moveThisNoteSplit: CommandData & { isMovingLeft: boolean };
                                                                                                                                                                                                                                                                                                                                                                                                                            noteContextReorder: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                                                                                newMainNtxId?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                ntxIdsInOrder: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                oldMainNtxId?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                            openAboutDialog: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            openBulkActionsDialog: | ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                            | { selectedOrActiveNoteIds?: string[] };
                                                                                                                                                                                                                                                                                                                                                                                                                            openedFileUpdated: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                                                                                entityId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                entityType: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                filePath: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                lastModifiedMs: number;
                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                            openGeoLocation: { event: MouseDownEvent; noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                            openInTab: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            openInWindow: NoteCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            openNewNoteSplit: NoteCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            openNoteInNewSplit: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            openNoteInNewTab: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            openNoteInNewWindow: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            openNoteInSplit: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            pasteNotesAfterFromClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            pasteNotesFromClipboard: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            protectSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            recentChangesInSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            reEvaluateRightPaneVisibility: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            refreshNoteList: CommandData & { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                            refreshResults: {};
                                                                                                                                                                                                                                                                                                                                                                                                                            refreshSearchDefinition: {};
                                                                                                                                                                                                                                                                                                                                                                                                                            reloadAttributes: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            reopenLastTab: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            replaceMisspelling: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            resetLauncher: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            runActiveNote: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            saveAttributes: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            scrollContainerToCommand: CommandData & { position: number };
                                                                                                                                                                                                                                                                                                                                                                                                                            scrollToEnd: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            searchInSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            searchNotes: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                                                                                ancestorNoteId?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                searchString?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                            selectAllNotesInParent: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            setActiveScreen: CommandData & { screen: Screen };
                                                                                                                                                                                                                                                                                                                                                                                                                            setZoomFactorAndSave: { zoomFactor: string };
                                                                                                                                                                                                                                                                                                                                                                                                                            showAddLinkDialog: CommandData & { text: string; textTypeWidget: default };
                                                                                                                                                                                                                                                                                                                                                                                                                            showConfirmDeleteNoteBoxWithNoteDialog: ConfirmWithTitleOptions;
                                                                                                                                                                                                                                                                                                                                                                                                                            showConfirmDialog: ConfirmWithMessageOptions;
                                                                                                                                                                                                                                                                                                                                                                                                                            showDeleteNotesDialog: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                                                                                branchIdsToDelete: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                callback: (value: ResolveOptions) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                forceDeleteAllClones: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                            showExportDialog: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                                                                                defaultType: "single"
                                                                                                                                                                                                                                                                                                                                                                                                                                | "subtree";
                                                                                                                                                                                                                                                                                                                                                                                                                                notePath: string;
                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                            showImportDialog: CommandData & { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                            showIncludeNoteDialog: CommandData & { textTypeWidget: default };
                                                                                                                                                                                                                                                                                                                                                                                                                            showInfoDialog: ConfirmWithMessageOptions;
                                                                                                                                                                                                                                                                                                                                                                                                                            showLaunchBarSubtree: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            showLeftPane: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            showOptions: CommandData & { section: string };
                                                                                                                                                                                                                                                                                                                                                                                                                            showPasswordNotSet: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            showPromptDialog: PromptDialogOptions;
                                                                                                                                                                                                                                                                                                                                                                                                                            showProtectedSessionPasswordDialog: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            showRecentChanges: CommandData & { ancestorNoteId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                            showRevisions: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            showUploadAttachmentsDialog: CommandData & { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                            sortChildNotes: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            toggleNoteHoisting: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            toggleZenMode: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            unprotectSubtree: ContextMenuCommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                            updateAttributeList: CommandData & { attributes: Attribute[] };
                                                                                                                                                                                                                                                                                                                                                                                                                            updateAttributesList: { attributes: Attribute[] };
                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                        addNewLabel +addNewLabelDefinition +addNewRelation +addNewRelationDefinition +addNoteLauncher +addScriptLauncher +addSpacerLauncher +addTextToActiveEditor +addWidgetLauncher +api-log-messages +cloneNoteIdsTo +cloneNotesTo +closeActiveTab +closeAllTabs +closeHlt +closeOtherTabs +closeProtectedSessionPasswordDialog +closeRightTabs +closeTab +closeThisNoteSplit +closeToc +closeTocCommand +collapseSubtree +convertNoteToAttachment +copyImageReferenceToClipboard +copyImageToClipboard +copyNotePathToClipboard +copyNotesToClipboard +copyTabToNewWindow +cutNotesToClipboard +delete +deleteFromMap +deleteNotes +duplicateSubtree +editBranchPrefix +editNoteTitle +enterProtectedSession +executeInActiveNoteDetailWidget +executeWithCodeEditor +executeWithContentElement +executeWithTextEditor +executeWithTypeWidget +expandSubtree +exportNote +focusAndSelectTitle +focusOnDetail +focusOnSearchDefinition +focusOnTitle +focusTree +hideFloatingButtons +hideLeftPane +hoistNote +importIntoNote +importMarkdownInline +insertChildNote +insertNoteAfter +leaveProtectedSession +moveBranchIdsTo +moveLauncherToAvailable +moveLauncherToVisible +moveNoteDown +moveNoteDownInHierarchy +moveNotesTo +moveNoteUp +moveNoteUpInHierarchy +moveTabToNewWindow +moveThisNoteSplit +noteContextReorder +openAboutDialog +openBulkActionsDialog +openedFileUpdated +openGeoLocation +openInTab +openInWindow +openNewNoteSplit +openNoteInNewSplit +openNoteInNewTab +openNoteInNewWindow +openNoteInSplit +pasteNotesAfterFromClipboard +pasteNotesFromClipboard +protectSubtree +recentChangesInSubtree +reEvaluateRightPaneVisibility +refreshNoteList +refreshResults +refreshSearchDefinition +reloadAttributes +reopenLastTab +replaceMisspelling +resetLauncher +runActiveNote +saveAttributes +scrollContainerToCommand +scrollToEnd +searchInSubtree +searchNotes +selectAllNotesInParent +setActiveScreen +setZoomFactorAndSave +showAddLinkDialog +showConfirmDeleteNoteBoxWithNoteDialog +showConfirmDialog +showDeleteNotesDialog +showExportDialog +showImportDialog +showIncludeNoteDialog +showInfoDialog +showLaunchBarSubtree +showLeftPane +showOptions +showPasswordNotSet +showPromptDialog +showProtectedSessionPasswordDialog +showRecentChanges +showRevisions +showUploadAttachmentsDialog +sortChildNotes +toggleNoteHoisting +toggleZenMode +unprotectSubtree +updateAttributeList +updateAttributesList +

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                        addNewLabel: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        addNewLabelDefinition: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        addNewRelation: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        addNewRelationDefinition: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        addNoteLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        addScriptLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        addSpacerLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        addTextToActiveEditor: CommandData & { text: string }
                                                                                                                                                                                                                                                                                                                                                                                                                        addWidgetLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        "api-log-messages": CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        cloneNoteIdsTo: CommandData & { noteIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                                                        cloneNotesTo: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        closeActiveTab: CommandData & { $el: JQuery<HTMLElement> }
                                                                                                                                                                                                                                                                                                                                                                                                                        closeAllTabs: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        closeHlt: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        closeOtherTabs: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        closeProtectedSessionPasswordDialog: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        closeRightTabs: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        closeTab: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        closeThisNoteSplit: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        closeToc: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        closeTocCommand: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        collapseSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        convertNoteToAttachment: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        copyImageReferenceToClipboard: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        copyImageToClipboard: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        copyNotePathToClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        copyNotesToClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        copyTabToNewWindow: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        cutNotesToClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        delete: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        deleteFromMap: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                                                        deleteNotes: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        duplicateSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        editBranchPrefix: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        editNoteTitle: {}
                                                                                                                                                                                                                                                                                                                                                                                                                        enterProtectedSession: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        executeInActiveNoteDetailWidget: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                                                                            callback: (value: default | PromiseLike<default>) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                        executeWithCodeEditor: CommandData & ExecuteCommandData<CodeMirrorInstance>
                                                                                                                                                                                                                                                                                                                                                                                                                        executeWithContentElement: CommandData & ExecuteCommandData<JQuery<HTMLElement>>

                                                                                                                                                                                                                                                                                                                                                                                                                        Called upon when attempting to retrieve the content element of a NoteContext. +Generally should not be invoked manually, as it is used by NoteContext.getContentElement.

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        executeWithTextEditor: CommandData & ExecuteCommandData<TextEditor> & {
                                                                                                                                                                                                                                                                                                                                                                                                                            callback?: GetTextEditorCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                        executeWithTypeWidget: CommandData & ExecuteCommandData<default | null>
                                                                                                                                                                                                                                                                                                                                                                                                                        expandSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        exportNote: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        focusAndSelectTitle: CommandData & { isNewNote?: boolean }
                                                                                                                                                                                                                                                                                                                                                                                                                        focusOnDetail: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        focusOnSearchDefinition: Required<CommandData>
                                                                                                                                                                                                                                                                                                                                                                                                                        focusOnTitle: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        focusTree: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        hideFloatingButtons: {}
                                                                                                                                                                                                                                                                                                                                                                                                                        hideLeftPane: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        hoistNote: CommandData & { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                                                        importIntoNote: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        importMarkdownInline: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        insertChildNote: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        insertNoteAfter: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        leaveProtectedSession: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        moveBranchIdsTo: CommandData & { branchIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                                                        moveLauncherToAvailable: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        moveLauncherToVisible: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        moveNoteDown: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        moveNoteDownInHierarchy: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        moveNotesTo: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        moveNoteUp: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        moveNoteUpInHierarchy: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        moveTabToNewWindow: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        moveThisNoteSplit: CommandData & { isMovingLeft: boolean }
                                                                                                                                                                                                                                                                                                                                                                                                                        noteContextReorder: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                                                                            newMainNtxId?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                            ntxIdsInOrder: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                            oldMainNtxId?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                        openAboutDialog: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        openBulkActionsDialog:
                                                                                                                                                                                                                                                                                                                                                                                                                            | ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                            | { selectedOrActiveNoteIds?: string[] }
                                                                                                                                                                                                                                                                                                                                                                                                                        openedFileUpdated: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                                                                            entityId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                            entityType: string;
                                                                                                                                                                                                                                                                                                                                                                                                                            filePath: string;
                                                                                                                                                                                                                                                                                                                                                                                                                            lastModifiedMs: number;
                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                        openGeoLocation: { event: MouseDownEvent; noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                                                        openInTab: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        openInWindow: NoteCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        openNewNoteSplit: NoteCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        openNoteInNewSplit: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        openNoteInNewTab: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        openNoteInNewWindow: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        openNoteInSplit: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        pasteNotesAfterFromClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        pasteNotesFromClipboard: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        protectSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        recentChangesInSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        reEvaluateRightPaneVisibility: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        refreshNoteList: CommandData & { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                                                        refreshResults: {}
                                                                                                                                                                                                                                                                                                                                                                                                                        refreshSearchDefinition: {}
                                                                                                                                                                                                                                                                                                                                                                                                                        reloadAttributes: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        reopenLastTab: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        replaceMisspelling: CommandData

                                                                                                                                                                                                                                                                                                                                                                                                                        Works only in the electron context menu.

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        resetLauncher: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        runActiveNote: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        saveAttributes: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        scrollContainerToCommand: CommandData & { position: number }
                                                                                                                                                                                                                                                                                                                                                                                                                        scrollToEnd: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        searchInSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        searchNotes: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                                                                            ancestorNoteId?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                            searchString?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                        selectAllNotesInParent: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        setActiveScreen: CommandData & { screen: Screen }

                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the active Screen (e.g. to toggle the tree sidebar). It triggers the EventMappings.activeScreenChanged event, but only if the provided screen is different than the current one.

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        setZoomFactorAndSave: { zoomFactor: string }
                                                                                                                                                                                                                                                                                                                                                                                                                        showAddLinkDialog: CommandData & { text: string; textTypeWidget: default }
                                                                                                                                                                                                                                                                                                                                                                                                                        showConfirmDeleteNoteBoxWithNoteDialog: ConfirmWithTitleOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        showConfirmDialog: ConfirmWithMessageOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        showDeleteNotesDialog: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                                                                            branchIdsToDelete: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                            callback: (value: ResolveOptions) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                            forceDeleteAllClones: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                        showExportDialog: CommandData & {
                                                                                                                                                                                                                                                                                                                                                                                                                            defaultType: "single" | "subtree";
                                                                                                                                                                                                                                                                                                                                                                                                                            notePath: string;
                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                        showImportDialog: CommandData & { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                                                        showIncludeNoteDialog: CommandData & { textTypeWidget: default }
                                                                                                                                                                                                                                                                                                                                                                                                                        showInfoDialog: ConfirmWithMessageOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        showLaunchBarSubtree: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        showLeftPane: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        showOptions: CommandData & { section: string }
                                                                                                                                                                                                                                                                                                                                                                                                                        showPasswordNotSet: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        showPromptDialog: PromptDialogOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        showProtectedSessionPasswordDialog: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        showRecentChanges: CommandData & { ancestorNoteId: string }
                                                                                                                                                                                                                                                                                                                                                                                                                        showRevisions: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        showUploadAttachmentsDialog: CommandData & { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                                                        sortChildNotes: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        toggleNoteHoisting: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        toggleZenMode: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        unprotectSubtree: ContextMenuCommandData
                                                                                                                                                                                                                                                                                                                                                                                                                        updateAttributeList: CommandData & { attributes: Attribute[] }
                                                                                                                                                                                                                                                                                                                                                                                                                        updateAttributesList: { attributes: Attribute[] }

                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                        addNewLabeladdNewLabelDefinitionaddNewRelationaddNewRelationDefinitionaddNoteLauncheraddScriptLauncheraddSpacerLauncheraddTextToActiveEditoraddWidgetLauncherapi-log-messagescloneNoteIdsTocloneNotesTocloseActiveTabcloseAllTabscloseHltcloseOtherTabscloseProtectedSessionPasswordDialogcloseRightTabscloseTabcloseThisNoteSplitcloseToccloseTocCommandcollapseSubtreeconvertNoteToAttachmentcopyImageReferenceToClipboardcopyImageToClipboardcopyNotePathToClipboardcopyNotesToClipboardcopyTabToNewWindowcutNotesToClipboarddeletedeleteFromMapdeleteNotesduplicateSubtreeeditBranchPrefixeditNoteTitleenterProtectedSessionexecuteInActiveNoteDetailWidgetexecuteWithCodeEditorexecuteWithContentElementexecuteWithTextEditorexecuteWithTypeWidgetexpandSubtreeexportNotefocusAndSelectTitlefocusOnDetailfocusOnSearchDefinitionfocusOnTitlefocusTreehideFloatingButtonshideLeftPanehoistNoteimportIntoNoteimportMarkdownInlineinsertChildNoteinsertNoteAfterleaveProtectedSessionmoveBranchIdsTomoveLauncherToAvailablemoveLauncherToVisiblemoveNoteDownmoveNoteDownInHierarchymoveNotesTomoveNoteUpmoveNoteUpInHierarchymoveTabToNewWindowmoveThisNoteSplitnoteContextReorderopenAboutDialogopenBulkActionsDialogopenedFileUpdatedopenGeoLocationopenInTabopenInWindowopenNewNoteSplitopenNoteInNewSplitopenNoteInNewTabopenNoteInNewWindowopenNoteInSplitpasteNotesAfterFromClipboardpasteNotesFromClipboardprotectSubtreerecentChangesInSubtreereEvaluateRightPaneVisibilityrefreshNoteListrefreshResultsrefreshSearchDefinitionreloadAttributesreopenLastTabreplaceMisspellingresetLauncherrunActiveNotesaveAttributesscrollContainerToCommandscrollToEndsearchInSubtreesearchNotesselectAllNotesInParentsetActiveScreensetZoomFactorAndSaveshowAddLinkDialogshowConfirmDeleteNoteBoxWithNoteDialogshowConfirmDialogshowDeleteNotesDialogshowExportDialogshowImportDialogshowIncludeNoteDialogshowInfoDialogshowLaunchBarSubtreeshowLeftPaneshowOptionsshowPasswordNotSetshowPromptDialogshowProtectedSessionPasswordDialogshowRecentChangesshowRevisionsshowUploadAttachmentsDialogsortChildNotestoggleNoteHoistingtoggleZenModeunprotectSubtreeupdateAttributeListupdateAttributesList
                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.CommandNames.html b/docs/backend_api/types/Frontend_Script_API._internal_.CommandNames.html new file mode 100644 index 000000000..c5da1ae0d --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.CommandNames.html @@ -0,0 +1,2 @@ +CommandNames | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias CommandNames

                                                                                                                                                                                                                                                                                                                                                                                                                          CommandNames: keyof CommandMappings

                                                                                                                                                                                                                                                                                                                                                                                                                          This type is a discriminated union which contains all the possible commands that can be triggered via AppContext.triggerCommand.

                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.ConfirmDialogCallback.html b/docs/backend_api/types/Frontend_Script_API._internal_.ConfirmDialogCallback.html new file mode 100644 index 000000000..e365a9177 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.ConfirmDialogCallback.html @@ -0,0 +1 @@ +ConfirmDialogCallback | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias ConfirmDialogCallback

                                                                                                                                                                                                                                                                                                                                                                                                                            ConfirmDialogCallback: (val?: ConfirmDialogResult) => void

                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.ConfirmDialogResult.html b/docs/backend_api/types/Frontend_Script_API._internal_.ConfirmDialogResult.html new file mode 100644 index 000000000..88fc642d5 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.ConfirmDialogResult.html @@ -0,0 +1 @@ +ConfirmDialogResult | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ConfirmDialogResult

                                                                                                                                                                                                                                                                                                                                                                                                                              ConfirmDialogResult: false | ConfirmDialogOptions

                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.ElementType.html b/docs/backend_api/types/Frontend_Script_API._internal_.ElementType.html new file mode 100644 index 000000000..d1890ab14 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.ElementType.html @@ -0,0 +1 @@ +ElementType | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ElementType

                                                                                                                                                                                                                                                                                                                                                                                                                                ElementType: HTMLElement | Document

                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.EventData.html b/docs/backend_api/types/Frontend_Script_API._internal_.EventData.html new file mode 100644 index 000000000..8845a6196 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.EventData.html @@ -0,0 +1 @@ +EventData | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias EventData<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                  EventData: CommandAndEventMappings[T]

                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.EventListener.html b/docs/backend_api/types/Frontend_Script_API._internal_.EventListener.html new file mode 100644 index 000000000..ba76a6dd3 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.EventListener.html @@ -0,0 +1 @@ +EventListener | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias EventListener<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                    EventListener: { [key in T as `${key}Event`]: (data: EventData<T>) => void }

                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.EventMappings.html b/docs/backend_api/types/Frontend_Script_API._internal_.EventMappings.html new file mode 100644 index 000000000..7037248c6 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.EventMappings.html @@ -0,0 +1,49 @@ +EventMappings | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias EventMappings

                                                                                                                                                                                                                                                                                                                                                                                                                                      type EventMappings = {
                                                                                                                                                                                                                                                                                                                                                                                                                                          activeContextChanged: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                                                                          activeNoteChanged: {};
                                                                                                                                                                                                                                                                                                                                                                                                                                          activeScreenChanged: { activeScreen: Screen };
                                                                                                                                                                                                                                                                                                                                                                                                                                          addNewLabel: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                                          addNewRelation: CommandData;
                                                                                                                                                                                                                                                                                                                                                                                                                                          apiLogMessages: { messages: string[]; noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                          beforeNoteContextRemove: { ntxIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                                                                          beforeNoteSwitch: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                                                                          cloneNoteIdsTo: { noteIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                                                                          contextsReopened: {
                                                                                                                                                                                                                                                                                                                                                                                                                                              afterNtxId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              mainNtxId: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                              ntxId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              tabPosition: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                          entitiesReloaded: { loadResults: default };
                                                                                                                                                                                                                                                                                                                                                                                                                                          exportPng: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                                                                          exportSvg: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                                                                          frocaReloaded: {};
                                                                                                                                                                                                                                                                                                                                                                                                                                          geoMapCreateChildNote: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                                                                          hoistedNoteChanged: { noteId: string; ntxId: string | null };
                                                                                                                                                                                                                                                                                                                                                                                                                                          initialRenderComplete: {};
                                                                                                                                                                                                                                                                                                                                                                                                                                          newNoteContextCreated: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                                                                          noteContextRemoved: { ntxIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                                                                          noteContextReorder: {
                                                                                                                                                                                                                                                                                                                                                                                                                                              newMainNtxId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              ntxIdsInOrder: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                              oldMainNtxId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                          noteDetailRefreshed: { ntxId?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                          | null };
                                                                                                                                                                                                                                                                                                                                                                                                                                          notesReloaded: { noteIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                                                                          noteSwitched: NoteSwitchedContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                          noteSwitchedAndActivated: NoteSwitchedContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                          noteTypeMimeChanged: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                          openBulkActionsDialog: { selectedOrActiveNoteIds: string[] };
                                                                                                                                                                                                                                                                                                                                                                                                                                          protectedSessionStarted: {};
                                                                                                                                                                                                                                                                                                                                                                                                                                          readOnlyTemporarilyDisabled: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                                                                          reEvaluateHighlightsListWidgetVisibility: { noteId: string | undefined };
                                                                                                                                                                                                                                                                                                                                                                                                                                          reEvaluateTocWidgetVisibility: { noteId: string | undefined };
                                                                                                                                                                                                                                                                                                                                                                                                                                          refreshData: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                                                                          refreshIncludedNote: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                          refreshNoteList: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                          relationMapCreateChildNote: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                                                                          relationMapResetPanZoom: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                                                                          relationMapResetZoomIn: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                                                                          relationMapResetZoomOut: { ntxId: string | null | undefined };
                                                                                                                                                                                                                                                                                                                                                                                                                                          searchRefreshed: { ntxId?: string | null };
                                                                                                                                                                                                                                                                                                                                                                                                                                          setNoteContext: { noteContext: NoteContext };
                                                                                                                                                                                                                                                                                                                                                                                                                                          showAddLinkDialog: { text: string; textTypeWidget: default };
                                                                                                                                                                                                                                                                                                                                                                                                                                          showHighlightsListWidget: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                          showIncludeDialog: { textTypeWidget: default };
                                                                                                                                                                                                                                                                                                                                                                                                                                          showSearchError: { error: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                          showTocWidget: { noteId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                          sqlQueryResults: CommandData & { results: SqlExecuteResults };
                                                                                                                                                                                                                                                                                                                                                                                                                                          tabReorder: { ntxIdsInOrder: string[] };
                                                                                                                                                                                                                                                                                                                                                                                                                                          zenModeChanged: { isEnabled: boolean };
                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                      activeContextChanged +activeNoteChanged +activeScreenChanged +addNewLabel +addNewRelation +apiLogMessages +beforeNoteContextRemove +beforeNoteSwitch +cloneNoteIdsTo +contextsReopened +entitiesReloaded +exportPng +exportSvg +frocaReloaded +geoMapCreateChildNote +hoistedNoteChanged +initialRenderComplete +newNoteContextCreated +noteContextRemoved +noteContextReorder +noteDetailRefreshed +notesReloaded +noteSwitched +noteSwitchedAndActivated +noteTypeMimeChanged +openBulkActionsDialog +protectedSessionStarted +readOnlyTemporarilyDisabled +reEvaluateHighlightsListWidgetVisibility +reEvaluateTocWidgetVisibility +refreshData +refreshIncludedNote +refreshNoteList +relationMapCreateChildNote +relationMapResetPanZoom +relationMapResetZoomIn +relationMapResetZoomOut +searchRefreshed +setNoteContext +showAddLinkDialog +showHighlightsListWidget +showIncludeDialog +showSearchError +showTocWidget +sqlQueryResults +tabReorder +zenModeChanged +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                      activeContextChanged: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                                                                      activeNoteChanged: {}
                                                                                                                                                                                                                                                                                                                                                                                                                                      activeScreenChanged: { activeScreen: Screen }

                                                                                                                                                                                                                                                                                                                                                                                                                                      Triggered when the CommandMappings.setActiveScreen command is invoked.

                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      addNewLabel: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                                      addNewRelation: CommandData
                                                                                                                                                                                                                                                                                                                                                                                                                                      apiLogMessages: { messages: string[]; noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                      beforeNoteContextRemove: { ntxIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                                                                      beforeNoteSwitch: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                                                                      cloneNoteIdsTo: { noteIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                                                                      contextsReopened: {
                                                                                                                                                                                                                                                                                                                                                                                                                                          afterNtxId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          mainNtxId: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                          ntxId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          tabPosition: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                      entitiesReloaded: { loadResults: default }
                                                                                                                                                                                                                                                                                                                                                                                                                                      exportPng: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                                                                      exportSvg: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                                                                      frocaReloaded: {}
                                                                                                                                                                                                                                                                                                                                                                                                                                      geoMapCreateChildNote: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                                                                      hoistedNoteChanged: { noteId: string; ntxId: string | null }
                                                                                                                                                                                                                                                                                                                                                                                                                                      initialRenderComplete: {}
                                                                                                                                                                                                                                                                                                                                                                                                                                      newNoteContextCreated: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                                                                      noteContextRemoved: { ntxIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                                                                      noteContextReorder: {
                                                                                                                                                                                                                                                                                                                                                                                                                                          newMainNtxId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          ntxIdsInOrder: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                          oldMainNtxId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                      noteDetailRefreshed: { ntxId?: string | null }
                                                                                                                                                                                                                                                                                                                                                                                                                                      notesReloaded: { noteIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                                                                      noteSwitched: NoteSwitchedContext
                                                                                                                                                                                                                                                                                                                                                                                                                                      noteSwitchedAndActivated: NoteSwitchedContext
                                                                                                                                                                                                                                                                                                                                                                                                                                      noteTypeMimeChanged: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                      openBulkActionsDialog: { selectedOrActiveNoteIds: string[] }
                                                                                                                                                                                                                                                                                                                                                                                                                                      protectedSessionStarted: {}
                                                                                                                                                                                                                                                                                                                                                                                                                                      readOnlyTemporarilyDisabled: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                                                                      reEvaluateHighlightsListWidgetVisibility: { noteId: string | undefined }
                                                                                                                                                                                                                                                                                                                                                                                                                                      reEvaluateTocWidgetVisibility: { noteId: string | undefined }
                                                                                                                                                                                                                                                                                                                                                                                                                                      refreshData: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                                                                      refreshIncludedNote: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                      refreshNoteList: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                      relationMapCreateChildNote: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                                                                      relationMapResetPanZoom: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                                                                      relationMapResetZoomIn: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                                                                      relationMapResetZoomOut: { ntxId: string | null | undefined }
                                                                                                                                                                                                                                                                                                                                                                                                                                      searchRefreshed: { ntxId?: string | null }
                                                                                                                                                                                                                                                                                                                                                                                                                                      setNoteContext: { noteContext: NoteContext }
                                                                                                                                                                                                                                                                                                                                                                                                                                      showAddLinkDialog: { text: string; textTypeWidget: default }
                                                                                                                                                                                                                                                                                                                                                                                                                                      showHighlightsListWidget: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                      showIncludeDialog: { textTypeWidget: default }
                                                                                                                                                                                                                                                                                                                                                                                                                                      showSearchError: { error: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                      showTocWidget: { noteId: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                      sqlQueryResults: CommandData & { results: SqlExecuteResults }
                                                                                                                                                                                                                                                                                                                                                                                                                                      tabReorder: { ntxIdsInOrder: string[] }
                                                                                                                                                                                                                                                                                                                                                                                                                                      zenModeChanged: { isEnabled: boolean }

                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                      activeContextChangedactiveNoteChangedactiveScreenChangedaddNewLabeladdNewRelationapiLogMessagesbeforeNoteContextRemovebeforeNoteSwitchcloneNoteIdsTocontextsReopenedentitiesReloadedexportPngexportSvgfrocaReloadedgeoMapCreateChildNotehoistedNoteChangedinitialRenderCompletenewNoteContextCreatednoteContextRemovednoteContextReordernoteDetailRefreshednotesReloadednoteSwitchednoteSwitchedAndActivatednoteTypeMimeChangedopenBulkActionsDialogprotectedSessionStartedreadOnlyTemporarilyDisabledreEvaluateHighlightsListWidgetVisibilityreEvaluateTocWidgetVisibilityrefreshDatarefreshIncludedNoterefreshNoteListrelationMapCreateChildNoterelationMapResetPanZoomrelationMapResetZoomInrelationMapResetZoomOutsearchRefreshedsetNoteContextshowAddLinkDialogshowHighlightsListWidgetshowIncludeDialogshowSearchErrorshowTocWidgetsqlQueryResultstabReorderzenModeChanged
                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.EventNames.html b/docs/backend_api/types/Frontend_Script_API._internal_.EventNames.html new file mode 100644 index 000000000..b3017f29e --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.EventNames.html @@ -0,0 +1 @@ +EventNames | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias EventNames

                                                                                                                                                                                                                                                                                                                                                                                                                                        EventNames: CommandNames | EventOnlyNames

                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.EventOnlyNames.html b/docs/backend_api/types/Frontend_Script_API._internal_.EventOnlyNames.html new file mode 100644 index 000000000..569f05bad --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.EventOnlyNames.html @@ -0,0 +1 @@ +EventOnlyNames | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias EventOnlyNames

                                                                                                                                                                                                                                                                                                                                                                                                                                          EventOnlyNames: keyof EventMappings

                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.Func.html b/docs/backend_api/types/Frontend_Script_API._internal_.Func.html new file mode 100644 index 000000000..9b6561002 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.Func.html @@ -0,0 +1 @@ +Func | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Func

                                                                                                                                                                                                                                                                                                                                                                                                                                            Func: ((...args: unknown[]) => unknown) | string

                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.GetTextEditorCallback.html b/docs/backend_api/types/Frontend_Script_API._internal_.GetTextEditorCallback.html new file mode 100644 index 000000000..442c8d1ec --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.GetTextEditorCallback.html @@ -0,0 +1 @@ +GetTextEditorCallback | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias GetTextEditorCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                              GetTextEditorCallback: (editor: TextEditor) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.Handler.html b/docs/backend_api/types/Frontend_Script_API._internal_.Handler.html new file mode 100644 index 000000000..a1a10c3d4 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.Handler.html @@ -0,0 +1 @@ +Handler | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Handler

                                                                                                                                                                                                                                                                                                                                                                                                                                                Handler: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                    e: TriggeredEvent<
                                                                                                                                                                                                                                                                                                                                                                                                                                                        ElementType
                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Element,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        ElementType | Element,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        ElementType | Element,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    >,
                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.LabelType.html b/docs/backend_api/types/Frontend_Script_API._internal_.LabelType.html new file mode 100644 index 000000000..932131b39 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.LabelType.html @@ -0,0 +1 @@ +LabelType | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias LabelType

                                                                                                                                                                                                                                                                                                                                                                                                                                                  LabelType: "text" | "number" | "boolean" | "date" | "datetime" | "time" | "url"

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.Multiplicity.html b/docs/backend_api/types/Frontend_Script_API._internal_.Multiplicity.html new file mode 100644 index 000000000..c16ee2eac --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.Multiplicity.html @@ -0,0 +1 @@ +Multiplicity | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Multiplicity

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Multiplicity: "single" | "multi"

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.NoteType.html b/docs/backend_api/types/Frontend_Script_API._internal_.NoteType.html new file mode 100644 index 000000000..8d6dabb3b --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.NoteType.html @@ -0,0 +1,4 @@ +NoteType | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                    trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias NoteType

                                                                                                                                                                                                                                                                                                                                                                                                                                                      NoteType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "file"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "image"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "search"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "noteMap"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "launcher"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "doc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "contentWidget"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "text"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "relationMap"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "render"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "canvas"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "mermaid"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "book"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "webView"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "code"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "mindMap"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "geoMap"

                                                                                                                                                                                                                                                                                                                                                                                                                                                      There are many different Note types, some of which are entirely opaque to the +end user. Those types should be used only for checking against, they are +not for direct use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.PromptShownDialogCallback.html b/docs/backend_api/types/Frontend_Script_API._internal_.PromptShownDialogCallback.html new file mode 100644 index 000000000..6ca14319a --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.PromptShownDialogCallback.html @@ -0,0 +1 @@ +PromptShownDialogCallback | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                      trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias PromptShownDialogCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                        PromptShownDialogCallback: ((callback: ShownCallbackData) => void) | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.Required.html b/docs/backend_api/types/Frontend_Script_API._internal_.Required.html new file mode 100644 index 000000000..22699a0c8 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.Required.html @@ -0,0 +1,2 @@ +Required | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                        trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Required<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required: { [P in keyof T]-?: T[P] }

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Make all properties in T required

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.Screen.html b/docs/backend_api/types/Frontend_Script_API._internal_.Screen.html new file mode 100644 index 000000000..666bd80b7 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.Screen.html @@ -0,0 +1 @@ +Screen | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                          trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Screen

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Screen: "detail" | "tree"

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.SqlExecuteResults.html b/docs/backend_api/types/Frontend_Script_API._internal_.SqlExecuteResults.html new file mode 100644 index 000000000..5cf0f9377 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.SqlExecuteResults.html @@ -0,0 +1 @@ +SqlExecuteResults | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                            trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias SqlExecuteResults

                                                                                                                                                                                                                                                                                                                                                                                                                                                              SqlExecuteResults: string[][][]

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/backend_api/types/Frontend_Script_API._internal_.TypeOrArray.html b/docs/backend_api/types/Frontend_Script_API._internal_.TypeOrArray.html new file mode 100644 index 000000000..5650f5132 --- /dev/null +++ b/docs/backend_api/types/Frontend_Script_API._internal_.TypeOrArray.html @@ -0,0 +1 @@ +TypeOrArray | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                              trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias TypeOrArray<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                TypeOrArray: T | T[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/backend_api/variables/Backend_Script_API.api.html b/docs/backend_api/variables/Backend_Script_API.api.html index 8cc4a4c63..6355b4263 100644 --- a/docs/backend_api/variables/Backend_Script_API.api.html +++ b/docs/backend_api/variables/Backend_Script_API.api.html @@ -1,2 +1,2 @@ api | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                                trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable apiConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  api: Api = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The code api global variable allows access to the backend script API, which is documented in Api.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/backend_api/variables/Frontend_Script_API.api.html b/docs/backend_api/variables/Frontend_Script_API.api.html new file mode 100644 index 000000000..c4083bd73 --- /dev/null +++ b/docs/backend_api/variables/Frontend_Script_API.api.html @@ -0,0 +1 @@ +api | trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  trilium
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variable apiConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    api: Api = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/src/public/app/services/frontend_script_api.ts b/src/public/app/services/frontend_script_api.ts index cfcf076cd..13b407a81 100644 --- a/src/public/app/services/frontend_script_api.ts +++ b/src/public/app/services/frontend_script_api.ts @@ -59,7 +59,7 @@ export interface Entity { type Func = ((...args: unknown[]) => unknown) | string; -interface Api { +export interface Api { /** * Container of all the rendered script content * */ diff --git a/src/public/app/services/frontend_script_entrypoint.ts b/src/public/app/services/frontend_script_entrypoint.ts new file mode 100644 index 000000000..fdc7bb6c4 --- /dev/null +++ b/src/public/app/services/frontend_script_entrypoint.ts @@ -0,0 +1,20 @@ +/** + * The front script API is accessible to code notes with the "JS (frontend)" language. + * + * All the variables listed are globally accessible to the script. + * + * @module Frontend Script API + */ + +/** + * This file creates the entrypoint for TypeDoc that simulates the context from within a + * script note. + * + * Make sure to keep in line with frontend's `script_context.ts`. + */ + +import FrontendScriptApi, { type Api } from "./frontend_script_api.js"; +export type { Api } from "./frontend_script_api.js"; + +//@ts-expect-error +export const api: Api = new FrontendScriptApi(); diff --git a/src/services/backend_script_entrypoint.ts b/src/services/backend_script_entrypoint.ts index 5271a76a0..d77b17a11 100644 --- a/src/services/backend_script_entrypoint.ts +++ b/src/services/backend_script_entrypoint.ts @@ -6,6 +6,13 @@ * @module Backend Script API */ +/** + * This file creates the entrypoint for TypeDoc that simulates the context from within a + * script note on the server side. + * + * Make sure to keep in line with backend's `script_context.ts`. + */ + import BNote from "../becca/entities/bnote.js"; import type { Api } from "./backend_script_api.js"; import BackendScriptApi from "./backend_script_api.js"; diff --git a/typedoc.json b/typedoc.json index 7b3af5524..3e8518b3a 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,6 +1,7 @@ { "entryPoints": [ - "src/services/backend_script_entrypoint.ts" + "src/services/backend_script_entrypoint.ts", + "src/public/app/services/frontend_script_entrypoint.ts" ], "plugin": [ "typedoc-plugin-missing-exports"