diff --git a/assets/navigation.js b/assets/navigation.js index a7af9f41..c2150bdc 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5WZT28TMRDFv8ueKwoVLaK3UkCC/klVUDkgDm7ixEM23mA7LRHiu6NNsru2135jrn5vfnFWfuNk9vufysnfrjqvLvT2whixrY6qtXCqOq9IO2nmYirtcSe+UG5VV0fVkvSsOj85Pft7NAJc01JCSGtAoPc0ddRoYdJ7GWQE+Wwbnf8+vcohbsQ6C7gRa+Z5XDbaOrOZusYMFLdd7x+Gp0acl2/fvDo9CVkfN3r3vROgTiqgtPtOENplrrr1XDZ1LZPbCNUS1p2hFTl6kilUL3KkK7mdzGPCbrGg8kHUm9HHd+tc/TU5aURt4/puvbT+Xk4bM8tR9irHuhF6GxPaNa7uttGT9S5NdVzuSSxlU9fisR49yW6dq5+syMW17Rpbl9l66b4nT9I8G3KjjfcCR7iXYvYtRegFnvBrQ0bObhude4wJy39Qcw8pYeGoDySfY0y7xtUJG3Xi+aFh2eODFBLOXgfF75qmlkKnyw8iBKQuFJ+Ru1EizLgD+5B0E44Qn7R1Qk9lGtGpEJG42HxG5mZLQIKrLUaM7rYIcLtZPUqTrt9rsHzy+FNOXbp8r8Hyu1qQRgzPAEFfnCG9SDP2Giy30mQ20Cps6eg+jgnJmzkFyp+HXmYhMGaegQVxcQs9LA7HznewKBw/38GimBgGliJYNo6egQUdrog86GDgQSDfg85iUEYHncWweY9MLBDlftABZtpIM5UgwIGBBcHTFFmKYJnTFBgAaCbnpMnJD9oZktb/hT3ARqYC4JXcMrS9owC1+5HOwDoPwEltNybZEfYKWwoOQWDgQbkD4MksBHTxwMCCcBePPSwOdfHQwaJQFw8dLArmLrIUwTK5CwwsKN98fZ3F5Bumr7MYpvmOTCww33x9HWJAV5IF3Wghk19lIdHmFxL9YBtUBpE7bZ2Gy0G8BxUjcLADAwahSHsyhqAwezKGwBj7Oo/JBHhQMSIf3V7EgHzQehEDmLiGDozKB7UXAUAJmypVwuIiELJBZRC5s6D4eYOCAwdVMnFQ3MhBFc4cFB46qKKpg8JjB1U0d1DM4EGVTR4UHD2oktmDQsMHVTB9UGj8oArmD4odQKjSCYRCIwhVMIMgFBcqSAvlw0JsVg6O8I3PCDB+3xNBQN6oIG5kL2th7YW1tNDtdPRrk0aNbBCKI0xlCSYYYCrJL8H4Ukl6CYeXirJLKLpUkFyy0csavzzxyiYqzqee+NATyDzxkScu8VQYeAJ5Jz7uy+zf5yX3t9k1oFP0IgTAQ+TJLCRziHoRAJ7Av/6n3L/9H/8AKbNJ6uceAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5WZX2/TMBTFv0ueJwYTG2JvY4AE+9NpoPGAePBat740dYrtblSI747SNont2OeaV597fk0Tn5vk5vufysnfrjqvPttG34h1dVSthVPVeUXaSTMXU2mPD9oL5VZ1dVQtSc+q85PTs79Hvf1Cby+MEdvB77ZraY+79cj78u2bV6cnCf81LWWO0WoFnMtGW2c2U9eYBMlTC1gfN3rqqNEJUCcVUNrzlyC0y5z7Pe1+RJjRmR0UjtH+TvLi9EIJ4bKpa5k8GaFawroztCJHT6NLHYgc6UpuJ/OYsFsscD6IejP6+W6d81+Tk0bUNvZ366X+ezltzCxH2asc60bo0YVt1zjfbaMn690OqmO7J7GUTV2Lx3p0Jrt1zj9ZkYu97Rrryxx66XFPnqR5NuRGB94LHOFeitm3FKEXeMKvDRk5u2107jQmSv6DmjtJiRKO+kDyOca0a5xP2KjzzA9t0x4fpJBw9jowv2uaWgqdth9ECEj1T5+R66IRZnwf8CHpW0GE+KStE3oq04hOhYhEI/cZmXaegAQ3+hgxutNHgNvN6lGatH+vQfvk8aecurR9r0H7XS1II4ZXAEFfnCG9SDP2GrRbaTIH0CqsdfRUEBOSzwcpUH4/9DILgTHzClgQF7ewhsXh2PkVLArHz69gUUwMg5IiWDaOXgELOtwi8qBDAQ8C+R50FoMyOugshs17VMQCUe4HHWCmjTRTCQIcFLAguJuikiJYZjcFBQA0k3PS5OQH7QxJ6z9hD7BRUQHwSm4Z2r6iALV7SGdgXQ3ASW03JtkR9gprBZsgKOBBuQ3gySwEdPGggAXhLh7XsDjUxcMKFoW6eFjBomDuopIiWCZ3QQELyjdfX2cx+Ybp6yyGab6jIhaYb76+DjGgK8mCbrSQyb+ykOjgFxI9sA0qg8jttk7DdhDvQcUIHOygAINQpD0ZQ1CYPRlDYIx9ncdkAjyoGJGPbi9iQD5ovYgBTFzDCozKB7UXAUAJm7IqYbEJhGxQGURuLyh+3qDgwEGVTBwUN3JQhTMHhYcOqmjqoPDYQRXNHRQzeFBlkwcFRw+qZPag0PBBFUwfFBo/qIL5g2IHEKp0AqHQCEIVzCAIxYUK0kL5sBCblUNF+L1mBBh/sokgIG9UEDeyl7Ww9sJaWuh2Ovq1SaNGZRCKI0xlCSYYYCrJL8H4Ukl6CYeXirJLKLpUkFyy0cca3574ZBOZ86knPvQEMk985IlLPBUGnkDeiY/7Mvv6vORem10DOkUvQgDcRJ7MQjKbqBcB4Am89T/l3vZ//AN1xWEn4x4AAA==" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index 27f45d78..a439c7da 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52bbXPjuA3Hv4v61rMr8VHKu+21nbne3e7NtbN94dm58SaKxVtHTiUn10xmv3sHkh8AGqDNvIxB/EXyB8AkIr8Ww/bPsbhZvhbfQn9X3DizKPrVQ1vcFKvxX7sh9OtiUTwNm+KmuH/qb3dh24/vD6Z33e5hUyyK281qHNuxuCmK7wtW6uPTw9d2YKVm0/VSf91uN+2qZ7X2tuvFPn39o73dsVqz6XqpXzer0Cf0kP160b+FyX81vLCaJ/P1kj/2427V37as4MF4vdyHYVjxk5ss1wv9Y+/Kah2M18v9c9z2v6weWbW9LU9MXujRer3g2A58lIAhT+bjtv/4tNmIant7nmgi9U/mzHnKJeBkzpNMlQJkzxNNpPDJnCd5qTREY/LEL5QIOiRPOlkq8IA8WTmTjtY8wWTpwAMy59m/QGrLM53teaKpuoTs+aLpXc2uUbfbdrht5S0g9jxReQuIPV9U2oJoxLXCbT8+DVzwz4Y8GbGiYnOepFhRsTlPUq6oxJ4nKlY+bM6TTFfUszF54smKGg/Jk05UVDogT1YKfGTNE0xUVDogc55iOSH2PFG5nBB7vmh6V7PLybrlYnXdXh2d61Y+lx1tGWJi/TjaMsTkynEyZsiJuX20ZYilqwUdkCGbrBPEniGaqBDImiEoRfHBlCGVqArImjM3sR6cjBlyciU4GTPlEruXXQC61cgodasxQ0AsAF1uU6ZLdGW63LZMl+rLdNmNmS7RmelyWzPdpd5M96bmTHehO9O9pT3TJfszXX6DppM7NF1mi6ZL9mi6/CYNTEAsACdjhpxcALrsrk+Xbvt0b+j7BDl9Q2b2Bjl5Q2buhkTqhtzMDXLihsy8DalwC9nRFi5UgfCWIhDSNSC8oQSEVAUI2QUgjD/AiA/jGNb96uum/feW1T0bdf0DpBQJefVlP/zn8I1f+dGaISiWl5BbXUKiuITc2hKSpSW8pbL81L58umfFJsu1Qt/al5HVmQ3XX6J2Q2h5paPtWrHn1eZJ0DqYrpW6a+9DH3bt3xPzOxuTK/6TtId0QK7sZ3kb4iHXSu+2coYcbdeLyRlytOWJSRmCrElBVTa+suqoSpNk9/LYju8vpwejMm30udD0cVrLuqMO89UR+l073K9u2/H9ld8cWPBD/0J3DMkdbNlipB4zghcrcrx9H7f9p8dpaZtoB5ElS/G39r9PYWjvZGVmxFufAP9Mg29I+QmHEVlP+Dns2mG1GSPZw8dZWh/6l7Oj0yyHLOlMtFafQuH338H7gtRfjqOQ4qJ4XA1tv4smlZz6D9t+3A1Pt7vtcP5IZEwuwFbq4vRjrStWgOcmLwKK069DeAi78Bw/l9iyqILnD9vNpuXAUmNutJCvgOP+XCz+uFzEtR9VimtKfywl1rG3Ff5DGv3W3m6HOyHHZmOW7qeHsIvU4KPM2rK6+88QducVZf95ltrn0P4ZCcFHeat6boc/mRkdP89T40vym+qwUHzfVHF/WfUvkQ58xGl8WRShv2v/V9y8Fs/tMEL+3RTqnX7XFIviPrSbO3iLalZeFLfbhwcoGV/2ts8tFAwYMQ95XxaLZbkw+p2z6suXxfLgMRmmD6ZhVbFYVtywigxTxWKpuGGKDNPFYqm5YZoMM8ViabhhhgyzxWJpuWGWDHPFYum4YY4M88Vi6blhngyri8Wy5obVZFhTLJYNN6yh2wu7XbEcqgjERIJHQVlUsOcVS6OiOCrY9ooFUlEiFex8xTKpKJQKNr9isVSUSwX7X7FkKoqmAgQVC6eidCqgULF8KgqoAhAVi6iijBSAUCwjRRkpAKFYRirKlylh+IyhjBSAUCwjRRkpAKFYRooyUgBCsYwUZaQAhGIZKcpIAQjFMlKUkQIQimWkKCMFIBTLSFFGGkBolpGmjDSA0CwjTRlpAKFZRjoqa1Nd4wsbZaQBhGYZacpIAwjNMtKUkQYQmmWkKSMNIDTLSFNGGkBolpGmjDSA0CwjTRkZAGFYRoYyMgDCsIwMZWQAhGEZGcrIAAjDMjLRt8/09cN//1BGBkAYlpGhjAyAMCwjQxkZAGFYRoYyMgDCsIwMZWQAhGEZGcrIAgjLMrKUkQUQlmVkKSMLICzLyFJGFkBYlpGljCyAsCwjGx0SplMCf0ygjCyAsCwjSxlZAGFZRpYysgDCsowsZWQBhGUZWcrIAQjHMnKUkQMQjmXkKCMHIBzLyFFGDkA4lpGjjByAcCwjRxk5AOFYRi46y02HOf40Rxk5AOFYRo4ycgDCsYwcZeQAhGMZOcrIAwjPMvKUkQcQnmXkKSMPIDzLyFNGHkB4lpGnjDyA8CwjTxl5AOFZRp4y8gDCs4x8dOSeztz8oZsy8gDCs4w8ZeQBhGcZecqoBhA1y6imjGoAUbOMasqoBhA1y6imjGoAUbOMasqoBhA1y6imjGoAUbOMasqoBhA1y6imjGoAUbOM6uhmNF2N+LsRZVQDiJplVFNGDYBoWEYNZdQAiIZl1FBGDYBoWEYNZdQAiIZl1FBGDYBoWEYNZdQAiIZl1FBGDYBoWEYNZdQAiIZl1FBGDYBoWEZNdIGdbrD8FTa+w86XWOEWG11jy+keW1YLXb+zxkSDo5tsOV1lS/4uW0aX2VKnlKP7bDldaEv+7ltGV9pyutOW/PW3jG615XStLfkbcBldbMvpZlvyl+AyutuW0+W25O/BZXS9Laf7bclfhcuI4L4Nwd+GzxoRcyeCxx33IuZmhNS3iAjO/QihdRF3JOaWhNC9iJsSc1dCaGDEfYm5MSH0MPatiakd99wOu/bux7ktt1weu/yvxe/7Xh2E477Z91pAeN+8fl8UEI03r9+/n9p08Bc8ZtW/rOa280mjMSeJxlxw3Ez/KkPOFjlb2fkW/8cDz1/h+StZ4P743x7sXWLvUvb+Y4w9LfZ0kud4tlv+5OdFr6+Ht41Ofmid4irHO/Tv0pMrmqq4wyO3P/XJsRYdw/FVnJOjOznKWwN7erY9FSGS9H2Af6WgSEKBJPr1+zfC0APR80S37f6NqJObPrmJuTI+wttS574oX8R02f/8Ec0TT1SeKbgx8apw+MjxM3nHSBRComQk4MvEbYUTRQ4/8Oajt0JRWMlhCAJcDCu0byq9b1wkVyisKjmuwJ2NZ4VgqzRtJqYVCjMlxxl499u+n37jiuaOa2MaOpMXaOJVeuLnEV6hAlDJFQCchRypUJ2s5EIJCuP+hVHkjLatSmzbmSOKdCnQ5x/KcSmGAl1JgT5785GCVqykFZ/840hBO66kHT+8A7V/vWx7T4o9mn8tzf+gAK+6Re5oAvWlCTxPL2FFAmj9tbR+vkQ0iHcj8T78VBHtGaosSqossxvDWyNvfcE7Zq3RZmlps2ZfpqRqVNK0VNJmb36/NMptLeX2LMCVVI1IaYnU7M6VVI0CTUuBNruziWJQlhopTU/+UaJoVNC1VNBn7/OiqNGjdfrRzJEBlWMtlePZWSiKGp860nF+XtsUWriSF85VBvTYWnrs9NM9BAnFqJFidN1yZxWLXG3K9Sww0AqNtMJ1y51SDD6TSRmxboUjikEJYaSEWLfs+cSikLJSSK1b9nBiUAkyUglat/zJxCKqNkGVySGLItlKkbxumVOFQQ81iYcyh2ZUNYxUNdatdJ4wqOIaqeKuW+YwYdBijbTY6XdraINQOFkpnLrVyES/Q64u5RrzdGieLjFPJvotil8rxW8nXS8dimAnRXDH3zAdigcnxUMnXDJRnXBSneiEe6bDV1QpHjr2oulQJDopEjvurmnRQ23ioefha1GmWynTO/HGaVFltFJl7LgTscXNA2mxgQtkj6bspSkHpkGCNslLm7T3i7tJHndXpEAOXAo4tENO2qEwTm+8rY4/AdptydPRXnl5r/gs8igTvJQJgU0ijxLBS4kQ2BzyqNp4qdoEPoVqlPe1lPeByyCPNtvLm/2tfYkOImihtbzQ88RzKBadHIvniePRGr28RiHtPCrJXirJgck6h+LYSXEs9M/wxbmU1gq+t+hFaSyAL/6lFMYMVfg3AfJMTfvx9OY39sfX9lKKxrOoaFBUNFJUMBdWBKeW4HxrX57n37Gg5yHHRnLcHH+rgBxxi1IK+4PjsH8NG+8P7oSVksDD9M4ubhziDpzYjem3/fb4FjKaM2LaiL7HV47xY3EciZ2/7fR2OF4kbriJHWBuqhVp+4g9q+3pzW3si3tlYs9oaFd3jC/uWYu92WH/65d9oy7erwbBbaS0RRosLJT7jZR/uy3zZV3jVr/09N2WLTkNWn4jAZt9o4pRI9a1FM9srwjFVi2Bfp5e88ecSAudzdwvi+IxPLab0LfFzfLL9+//B3K+vvX/UwAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52bbXPbyA3Hvwv7VpOQ+0j6XZq2M9e7S26unfSFJpNRbFrci0y5pOyrJ5Pv3gGpB2AFrLR+lwiLP3f3B0C7MPW9GLZ/jsXN8nvxLfR3xY0zi6JfPbTFTbEa/7UbQr8uFsXTsCluivun/nYXtv349mB60+0eNsWiuN2sxrEdi5ui+LFgpT48PXxtB1ZqNl0v9dftdtOuelZrb7te7OPXP9rbHas1m66X+m2zCn1CD9mvF/1bmPxXwwureTJfL/lTP+5W/W3LCh6M18u9G4YVP7nJcr3QP/aurNbBeL3cP8dt/+vqkVXb2/LE5IUerdcLju3ARwkY8mQ+bPsPT5uNqLa354kmUv9kzpynXAJO5jzJVClA9jzRRAqfzHmSl0pDNCZP/EKJoEPypJOlAg/Ik5Uz6WjNE0yWDjwgc579C6S2PNPZnieaqkvIni+a3tXsGnW7bYfbVt4CYs8TlbeA2PNFpS2IRlwr3Pbj08AF/2zIkxErKjbnSYoVFZvzJOWKSux5omLlw+Y8yXRFPRuTJ56sqPGQPOlERaUD8mSlwEfWPMFERaUDMucplhNizxOVywmx54umdzW7nKxbLlbX7dXRuW7lc9nRliEm1o+jLUNMrhwnY4acmNtHW4ZYulrQARmyyTpB7BmiiQqBrBmCUhQfTBlSiaqArDlzE+vByZghJ1eCkzFTLrF72QWgW42MUrcaMwTEAtDlNmW6RFemy23LdKm+TJfdmOkSnZkutzXTXerNdK9qznQXujPda9ozXbI/0+U3aDq5Q9Nltmi6ZI+my2/SwATEAnAyZsjJBaDL7vp06bZP94q+T5DTN2Rmb5CTN2TmbkikbsjN3CAnbsjM25AKt5AdbeFCFQivKQIhXQPCK0pASFWAkF0AwvgeRrwbx7DuV1837b+3rO7ZqOsfIKVIyKsv++G/hG/8yo/WDEGxvITc6hISxSXk1paQLC3hNZXl5/bl4z0rNlmuFfrWvoyszmy4/hK1G0LLKx1t14o9rzZPgtbBdK3UXXsf+rBr/56Y39mYXPGfpT2kA3JlP8nbEA+5Vnq3lTPkaLteTM6Qoy1PTMoQZE0KqrLxlVVHVZoku5fHdnx7OT0YlWmjz4Wmj7O0mK+PWe3aLw5rtTuqffkCzmmlvxwHIcFF8bga2n5HZyRP+13/QtnMjzp8nLUFBydS+Knexaofa37Y9h8fp2VsIklkyVL8vf3vUxjaO1mZGfHaJ8Af7OBbWH7CYUTWE34Ju3ZYbcZI9vBxLrWz49kR2nVns8uhG0tdil08qeTU32/7cTc83e62w/kjkTG5AFupi9OPta5YAZ6bvAgogL8N4SHswnP8XGLLogqe77ebTcuBpcbcaCFfM8f9ufgFo6wjs8PfL6HftcP96nY/t0tfL9xiuSr2uu+WQxb93t5uhzshxWZjlu7Hh7CL1OCjzNKyuvvPEHbnBWX/eZbap9D+GQnBR3mrem6HP5kZHT/PU+Mr8qvKsFB7X1Vwf131cXDBR5zG50UR+rv2f8XN9+K5HUZIv5tCvdFvmmJR3Id2cwcvas3Ki+J2+/AAFePz3vaphXoBI+Yhb8tisSwXRr/x2n/+vFgePCbD9ME0rCoWy4obVpFhqlgsFTdMkWG6WCw1N0yTYaZYLA03zJBhtlgsLTfMkmGuWCwdN8yRYb5YLD03zJNhdbFY1tywmgxrisWy4YY1dHthtyuWQxWBmEjwKCiLCva8YmlUFEcF216xQCpKpIKdr1gmFYVSweZXLJaKcqlg/yuWTEXRVICgYuFUlE4FFCqWT0UBVQCiYhFVlJECEIplpCgjBSAUy0hF+TIlDJ8xlJECEIplpCgjBSAUy0hRRgpAKJaRoowUgFAsI0UZKQChWEaKMlIAQrGMFGWkAIRiGSnKSAMIzTLSlJEGEJplpCkjDSA0y0hHZW2qa3xho4w0gNAsI00ZaQChWUaaMtIAQrOMNGWkAYRmGWnKSAMIzTLSlJEGEJplpCkjAyAMy8hQRgZAGJaRoYwMgDAsI0MZGQBhWEYm+vaZvn747x/KyAAIwzIylJEBEIZlZCgjAyAMy8hQRgZAGJaRoYwMgDAsI0MZWQBhWUaWMrIAwrKMLGVkAYRlGVnKyAIIyzKylJEFEJZlZKNDwnRK4I8JlJEFEJZlZCkjCyAsy8hSRhZAWJaRpYwsgLAsI0sZOQDhWEaOMnIAwrGMHGXkAIRjGTnKyAEIxzJylJEDEI5l5CgjByAcy8hFZ7npMMef5igjByAcy8hRRg5AOJaRo4wcgHAsI0cZeQDhWUaeMvIAwrOMPGXkAYRnGXnKyAMIzzLylJEHEJ5l5CkjDyA8y8hTRh5AeJaRj47c05mbP3RTRh5AeJaRp4w8gPAsI08Z1QCiZhnVlFENIGqWUU0Z1QCiZhnVlFENIGqWUU0Z1QCiZhnVlFENIGqWUU0Z1QCiZhnVlFENIGqWUR3djKarEX83ooxqAFGzjGrKqAEQDcuooYwaANGwjBrKqAEQDcuooYwaANGwjBrKqAEQjVlo+0Y5Q0dSRg2AaFhGDWXUAIiGZdRQRg2AaFhGDWXUAIiGZdREF9jpBstfYeM77HyJFW6x0TW2nO6xJX+RLaObbKnEbZ1teOx0mS35e28ZXWdLmddsw2OnG23JX5PL6E5bTpfakr8pl9G1tpzutSV/WS6jm205XW1L/r5cRpfbcrrdlvyVuYz47ZsQ/K35rA0x8+MvznEnYm5FCP2NuBkxdyOkFkcEcG5ICF2OuCUx9ySERkfclZjbEkKvI25MzJ0Jod2x701Mnbvndti1dz/NHbzl8vj3gO/Fl31brzn+cfN70Zji5vuPRQFBvv/H9MmPU2MP/gdPW/Uvq7lHjaQskrIXHDfTn9WQs0POTna+xX8iOblDBh79Ie9Egfvjn4ewd4W9K9n7jzH2tNjTS57j2W75k5/s9fXwCtTJD61TiX536O+3J1c0VRHPyO1PfXKsRcdwfD/o5IigikxH2NOz7alKvK9J3wf42wuKJBRIol+/f00NPRA9T3Tb7l/TOrnpk5sYdOMjvMJ17otST8yz/W8y0TzxROWZghsTrwqHjxw/k3eMRCEkSkYCvkzcVjhR5PADbz56KxSFlRyGIMDFsEL7ptL7xkVyhcKqkuMK3Nl4Vgi2StNmYlqhMFNynIF3v+376Ye3aO64NqahM3mBJl6lJ34e4RUqAJVcAcBZyJEK1clKLpSgMO7fYkXOaNuqxLadOaJIlwJ9/vUel2Io0JUU6LM3HyloxUpa8ck/jhS040ra8cOLWft33rb3pNij+dfS/A8K8P5d5I4mUF+awPP0ZlgkgNZfS+vnS0SDeDcS78PvJ9GeocqipMoyuzG8NfLWF7xj1hptlpY2a/ZlSqpGJU1LJW325vdLo9zWUm7PAlxJ1YiUlkjN7lxJ1SjQtBRoszubKAZlqZHS9OQfJYpGBV1LBX32Pi+KGj1apx/NHBlQOdZSOZ6dhaKo8akjHefntU2hhSt54VxlQI+tpcdOvydEkFCMGilG1y13VrHI1aZczwIDrdBIK1y33CnF4DOZlBHrVjiiGJQQRkqIdcueTywKKSuF1LplDycGlSAjlaB1y59MLKJqE1SZHLIokq0UyeuWOVUY9FCTeChzaEZVw0hVY91K5wmDKq6RKu66ZQ4TBi3WSIudfkyHNgiFk5XCqVuNTPQ75OpSrjFPh+bpEvNkot+i+LVS/HbS9dKhCHZSBHf8DdOheHBSPHTCJRPVCSfViU64Zzp8RZXioWMvmg5FopMisePumhY91CYeeh6+FmW6lTK9E2+cFlVGK1XGjjsRW9w8kBYbuED2aMpemnJgGiRok7y0SXu/uJvkcXdFCuTApYBDO+SkHQrj9I7c6vi7pN2WPB3tlZf3is8ijzLBS5kQ2CTyKBG8lAiBzSGPqo2Xqk3gU6hGeV9LeR+4DPJos7282d/al+ggghZayws9TzyHYtHJsXieOB6t0ctrFNLOo5LspZIcmKxzKI6dFMdC/wxfnEtpc8H3Fr1ZjQXwxb+UEpChCn8tQJ7SNoPn4+lVceyPr+2llEBnUdGgqGikqGAurAhOLcH51r48zz+uQc9Djo3kuDn+uAEvkDQ3pXA6uA77V7exAO6Fie3Rh+k9X9w6xD04sZvSb/vt8c1ltFwUUI3oe3xNGT8WR5LYBtpOb5TjReKWm9jq5KZakcaP2G3cnt72xr64WyZ2vIZ2dcf4YrBiq23Y/2Bm36qL96vBHWwpcZEGCwsFSCNl4G7LfF3XuNkve7JFp0HLb6SonH2jmlGjNdfSmtluEYqtWoL1PP00AHMiTXT2W/bzongMj+0m9G1xs/z848f/AZex6xqWVAAA"; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css index 98a43779..072daed8 100644 --- a/assets/style.css +++ b/assets/style.css @@ -405,7 +405,8 @@ dd { } body { background: var(--color-background); - font-family: "Segoe UI", sans-serif; + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; font-size: 16px; color: var(--color-text); } diff --git a/functions/asArray.html b/functions/asArray.html index 2162d1ba..33824888 100644 --- a/functions/asArray.html +++ b/functions/asArray.html @@ -1,6 +1,6 @@ asArray | @salesforce/ts-types

Function asArray

  • asArray<T>(value): Optional<T[]>

  • Narrows an unknown value to an Array if it is type-compatible, or returns undefined otherwise.

    Type Parameters

    • T = unknown

    Parameters

    • value: unknown

      The value to test.

      -

    Returns Optional<T[]>

  • asArray<T>(value, defaultValue): T[]

  • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

    +

Returns Optional<T[]>

  • asArray<T>(value, defaultValue): T[]

  • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

    Type Parameters

    • T = unknown

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: T[]

      The default to return if value was undefined or of the incorrect type.

      -

    Returns T[]

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns T[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asBoolean.html b/functions/asBoolean.html index 3af92d5c..70da0dcb 100644 --- a/functions/asBoolean.html +++ b/functions/asBoolean.html @@ -1,6 +1,6 @@ asBoolean | @salesforce/ts-types

    Function asBoolean

    • asBoolean(value): Optional<boolean>

    • Narrows an unknown value to a boolean if it is type-compatible, or returns undefined otherwise.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns Optional<boolean>

    • asBoolean(value, defaultValue): boolean

    • Narrows an unknown value to a boolean if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<boolean>

  • asBoolean(value, defaultValue): boolean

  • Narrows an unknown value to a boolean if it is type-compatible, or returns the provided default otherwise.

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: boolean

      The default to return if value was undefined or of the incorrect type.

      -

    Returns boolean

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asDictionary.html b/functions/asDictionary.html index 355bc651..f8b62c92 100644 --- a/functions/asDictionary.html +++ b/functions/asDictionary.html @@ -1,6 +1,6 @@ -asDictionary | @salesforce/ts-types

    Function asDictionary

    • asDictionary<T>(value): Optional<Dictionary<T>>

    • Narrows an unknown value to a Dictionary<T> if it is type-compatible, or returns undefined otherwise.

      +asDictionary | @salesforce/ts-types

      Function asDictionary

      • asDictionary<T>(value): Optional<Dictionary<T>>

      • Narrows an unknown value to a Dictionary<T> if it is type-compatible, or returns undefined otherwise.

        Type Parameters

        • T = unknown

        Parameters

        • value: unknown

          The value to test.

          -

        Returns Optional<Dictionary<T>>

      • asDictionary<T>(value, defaultValue): Dictionary<T>

      • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

        +

      Returns Optional<Dictionary<T>>

    • asDictionary<T>(value, defaultValue): Dictionary<T>

    • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

      Type Parameters

      • T = unknown

      Parameters

      • value: unknown

        The value to test.

        -
      • defaultValue: Dictionary<T>

        The default to return if value was undefined or of the incorrect type.

        -

      Returns Dictionary<T>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • defaultValue: Dictionary<T>

    The default to return if value was undefined or of the incorrect type.

    +

    • Returns Dictionary<T>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asFunction.html b/functions/asFunction.html index c86f237f..db2ca451 100644 --- a/functions/asFunction.html +++ b/functions/asFunction.html @@ -1,6 +1,6 @@ asFunction | @salesforce/ts-types

    Function asFunction

    • asFunction(value): Optional<AnyFunction>

    • Narrows an unknown value to an AnyFunction if it is type-compatible, or returns undefined otherwise.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns Optional<AnyFunction>

    • asFunction(value, defaultValue): AnyFunction

    • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<AnyFunction>

  • asFunction(value, defaultValue): AnyFunction

  • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

    Parameters

    • value: unknown

      The value to test.

      -
    • defaultValue: AnyFunction<unknown>

      The default to return if value was undefined or of the incorrect type.

      -

    Returns AnyFunction

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • defaultValue: AnyFunction

    The default to return if value was undefined or of the incorrect type.

    +

    • Returns AnyFunction

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asInstance.html b/functions/asInstance.html index 8ee544c6..03a2b484 100644 --- a/functions/asInstance.html +++ b/functions/asInstance.html @@ -1,7 +1,7 @@ asInstance | @salesforce/ts-types

    Function asInstance

    • asInstance<C>(value, ctor): Optional<InstanceType<C>>

    • Narrows an unknown value to an instance of constructor type T if it is type-compatible, or returns undefined otherwise.

      -

      Type Parameters

      Parameters

      • value: unknown

        The value to test.

        -
      • ctor: C

      Returns Optional<InstanceType<C>>

    • asInstance<C>(value, ctor, defaultValue): InstanceType<C>

    • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

      -

      Type Parameters

      Parameters

      • value: unknown

        The value to test.

        +

        Type Parameters

        Parameters

        • value: unknown

          The value to test.

          +
        • ctor: C

        Returns Optional<InstanceType<C>>

      • asInstance<C>(value, ctor, defaultValue): InstanceType<C>

      • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

        +

        Type Parameters

        Parameters

        • value: unknown

          The value to test.

        • ctor: C
        • defaultValue: InstanceType<C>

          The default to return if value was undefined or of the incorrect type.

          -

        Returns InstanceType<C>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns InstanceType<C>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asJsonArray.html b/functions/asJsonArray.html index 1704320c..c70fa84d 100644 --- a/functions/asJsonArray.html +++ b/functions/asJsonArray.html @@ -1,6 +1,6 @@ -asJsonArray | @salesforce/ts-types

    Function asJsonArray

    • asJsonArray(value): Optional<JsonArray>

    • Narrows an AnyJson value to a JsonArray if it is type-compatible, or returns undefined otherwise.

      +asJsonArray | @salesforce/ts-types

      Function asJsonArray

      • asJsonArray(value): Optional<JsonArray>

      • Narrows an AnyJson value to a JsonArray if it is type-compatible, or returns undefined otherwise.

        Parameters

        Returns Optional<JsonArray>

      • asJsonArray(value, defaultValue): JsonArray

      • Narrows an AnyJson value to a JsonArray if it is type-compatible, or returns the provided default otherwise.

        +

      Returns Optional<JsonArray>

    • asJsonArray(value, defaultValue): JsonArray

    • Narrows an AnyJson value to a JsonArray if it is type-compatible, or returns the provided default otherwise.

      Parameters

      • value: Optional<AnyJson>

        The value to test.

        -
      • defaultValue: JsonArray

        The default to return if the value was undefined or of the incorrect type.

        -

      Returns JsonArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • defaultValue: JsonArray

    The default to return if the value was undefined or of the incorrect type.

    +

    • Returns JsonArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asJsonMap.html b/functions/asJsonMap.html index 366548d5..db75bee4 100644 --- a/functions/asJsonMap.html +++ b/functions/asJsonMap.html @@ -1,6 +1,6 @@ asJsonMap | @salesforce/ts-types

    Function asJsonMap

    • asJsonMap(value): Optional<JsonMap>

    • Narrows an AnyJson value to a JsonMap if it is type-compatible, or returns undefined otherwise.

      Parameters

      Returns Optional<JsonMap>

    • asJsonMap(value, defaultValue): JsonMap

    • Narrows an AnyJson value to a JsonMap if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<JsonMap>

  • asJsonMap(value, defaultValue): JsonMap

  • Narrows an AnyJson value to a JsonMap if it is type-compatible, or returns the provided default otherwise.

    Parameters

    • value: Optional<AnyJson>

      The value to test.

    • defaultValue: JsonMap

      The default to return if value was undefined or of the incorrect type.

      -

    Returns JsonMap

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns JsonMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asNumber.html b/functions/asNumber.html index 410b0c4f..83023926 100644 --- a/functions/asNumber.html +++ b/functions/asNumber.html @@ -1,6 +1,6 @@ asNumber | @salesforce/ts-types

    Function asNumber

    • asNumber(value): Optional<number>

    • Narrows an unknown value to a number if it is type-compatible, or returns undefined otherwise.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns Optional<number>

    • asNumber(value, defaultValue): number

    • Narrows an unknown value to a number if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<number>

  • asNumber(value, defaultValue): number

  • Narrows an unknown value to a number if it is type-compatible, or returns the provided default otherwise.

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: number

      The default to return if value was undefined or of the incorrect type.

      -

    Returns number

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asObject.html b/functions/asObject.html index 50a499aa..17356cc3 100644 --- a/functions/asObject.html +++ b/functions/asObject.html @@ -1,6 +1,6 @@ asObject | @salesforce/ts-types

    Function asObject

    • asObject<T>(value): Optional<T>

    • Narrows an unknown value to an object if it is type-compatible, or returns undefined otherwise.

      Type Parameters

      • T extends object = object

      Parameters

      • value: unknown

        The value to test.

        -

      Returns Optional<T>

    • asObject<T>(value, defaultValue): T

    • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<T>

  • asObject<T>(value, defaultValue): T

  • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

    Type Parameters

    • T extends object = object

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: T

      The default to return if value was undefined or of the incorrect type.

      -

    Returns T

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asPlainObject.html b/functions/asPlainObject.html index 362b382a..30e28bd8 100644 --- a/functions/asPlainObject.html +++ b/functions/asPlainObject.html @@ -1,6 +1,6 @@ asPlainObject | @salesforce/ts-types

    Function asPlainObject

    • asPlainObject<T>(value): Optional<T>

    • Narrows an unknown value to a plain object if it is type-compatible, or returns undefined otherwise.

      Type Parameters

      • T extends object = object

      Parameters

      • value: unknown

        The value to test.

        -

      Returns Optional<T>

    • asPlainObject<T>(value, defaultValue): T

    • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<T>

  • asPlainObject<T>(value, defaultValue): T

  • Narrows an unknown value to an object if it is type-compatible, or returns the provided default otherwise.

    Type Parameters

    • T extends object = object

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: T

      The default to return if value was undefined or of the incorrect type.

      -

    Returns T

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/asString.html b/functions/asString.html index 223b4210..6de30e05 100644 --- a/functions/asString.html +++ b/functions/asString.html @@ -1,6 +1,6 @@ asString | @salesforce/ts-types

    Function asString

    • asString(value): Optional<string>

    • Narrows an unknown value to a string if it is type-compatible, or returns undefined otherwise.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns Optional<string>

    • asString(value, defaultValue): string

    • Narrows an unknown value to a string if it is type-compatible, or returns the provided default otherwise.

      +

    Returns Optional<string>

  • asString(value, defaultValue): string

  • Narrows an unknown value to a string if it is type-compatible, or returns the provided default otherwise.

    Parameters

    • value: unknown

      The value to test.

    • defaultValue: string

      The default to return if value was undefined or of the incorrect type.

      -

    Returns string

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assert.html b/functions/assert.html index 016fa2cd..589bc702 100644 --- a/functions/assert.html +++ b/functions/assert.html @@ -2,4 +2,4 @@

    Parameters

    Returns asserts condition

    Throws

    AssertionFailedError If the assertion failed.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertAnyJson.html b/functions/assertAnyJson.html index 81d6019f..edb155d8 100644 --- a/functions/assertAnyJson.html +++ b/functions/assertAnyJson.html @@ -3,4 +3,4 @@

    Parameters

    Returns asserts value is AnyJson

    Throws

    AssertionFailedError If the value was not a JSON value type.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertArray.html b/functions/assertArray.html index 02663b58..368ba07a 100644 --- a/functions/assertArray.html +++ b/functions/assertArray.html @@ -1,5 +1,5 @@ -assertArray | @salesforce/ts-types

    Function assertArray

    • assertArray(value, message?): asserts value is AnyArray<unknown>

    • Narrows an unknown value to an Array if it is type-compatible, or raises an error otherwise.

      +assertArray | @salesforce/ts-types

      Function assertArray

      • assertArray(value, message?): asserts value is AnyArray

      • Narrows an unknown value to an Array if it is type-compatible, or raises an error otherwise.

        Parameters

        • value: unknown

          The value to test.

        • Optional message: string

          The error message to use if value is not type-compatible.

          -

        Returns asserts value is AnyArray<unknown>

        Throws

        AssertionFailedError If the value was undefined.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns asserts value is AnyArray

    Throws

    AssertionFailedError If the value was undefined.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertBoolean.html b/functions/assertBoolean.html index 8f991dcb..39d2a4bc 100644 --- a/functions/assertBoolean.html +++ b/functions/assertBoolean.html @@ -2,4 +2,4 @@

    Parameters

    Returns asserts value is boolean

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertDictionary.html b/functions/assertDictionary.html index 27456580..fe82186d 100644 --- a/functions/assertDictionary.html +++ b/functions/assertDictionary.html @@ -1,6 +1,6 @@ -assertDictionary | @salesforce/ts-types

    Function assertDictionary

    • assertDictionary<T>(value, message?): asserts value is Dictionary<T>

    • Narrows an unknown value to a Dictionary<T> if it is type-compatible and tests positively +assertDictionary | @salesforce/ts-types

      Function assertDictionary

      • assertDictionary<T>(value, message?): asserts value is Dictionary<T>

      • Narrows an unknown value to a Dictionary<T> if it is type-compatible and tests positively with isDictionary, or raises an error otherwise.

        Type Parameters

        • T = unknown

        Parameters

        • value: unknown

          The value to test.

        • Optional message: string

          The error message to use if value is not type-compatible.

          -

        Returns asserts value is Dictionary<T>

        Throws

        AssertionFailedError If the value was undefined.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns asserts value is Dictionary<T>

    Throws

    AssertionFailedError If the value was undefined.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertFunction.html b/functions/assertFunction.html index 597f6758..1ad1f74a 100644 --- a/functions/assertFunction.html +++ b/functions/assertFunction.html @@ -1,5 +1,5 @@ -assertFunction | @salesforce/ts-types

    Function assertFunction

    • assertFunction(value, message?): asserts value is AnyFunction<unknown>

    • Narrows an unknown value to an AnyFunction if it is type-compatible, or raises an error otherwise.

      +assertFunction | @salesforce/ts-types

      Function assertFunction

      • assertFunction(value, message?): asserts value is AnyFunction

      • Narrows an unknown value to an AnyFunction if it is type-compatible, or raises an error otherwise.

        Parameters

        • value: unknown

          The value to test.

        • Optional message: string

          The error message to use if value is not type-compatible.

          -

        Returns asserts value is AnyFunction<unknown>

        Throws

        AssertionFailedError If the value was undefined.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns asserts value is AnyFunction

    Throws

    AssertionFailedError If the value was undefined.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertInstance.html b/functions/assertInstance.html index fbce6823..49d1c7cd 100644 --- a/functions/assertInstance.html +++ b/functions/assertInstance.html @@ -1,6 +1,6 @@ assertInstance | @salesforce/ts-types

    Function assertInstance

    • assertInstance<C>(value, ctor, message?): asserts value is InstanceType<C>

    • Narrows an unknown value to instance of constructor type T if it is type-compatible, or raises an error otherwise.

      -

      Type Parameters

      Parameters

      • value: unknown

        The value to test.

        +

        Type Parameters

        Parameters

        • value: unknown

          The value to test.

        • ctor: C
        • Optional message: string

          The error message to use if value is not type-compatible.

        Returns asserts value is InstanceType<C>

        Throws

        AssertionFailedError If the value was undefined.

        -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertJsonArray.html b/functions/assertJsonArray.html index e1df05c5..fa7b25d8 100644 --- a/functions/assertJsonArray.html +++ b/functions/assertJsonArray.html @@ -1,5 +1,5 @@ -assertJsonArray | @salesforce/ts-types

    Function assertJsonArray

    • assertJsonArray(value, message?): asserts value is JsonArray

    • Narrows an AnyJson value to a JsonArray if it is type-compatible, or raises an error otherwise.

      +assertJsonArray | @salesforce/ts-types

      Function assertJsonArray

      • assertJsonArray(value, message?): asserts value is JsonArray

      • Narrows an AnyJson value to a JsonArray if it is type-compatible, or raises an error otherwise.

        Parameters

        • value: Optional<AnyJson>

          The value to test.

        • Optional message: string

          The error message to use if value is not type-compatible.

          -

        Returns asserts value is JsonArray

        Throws

        AssertionFailedError If the value was undefined.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns asserts value is JsonArray

    Throws

    AssertionFailedError If the value was undefined.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertJsonMap.html b/functions/assertJsonMap.html index 38a07d45..0870720d 100644 --- a/functions/assertJsonMap.html +++ b/functions/assertJsonMap.html @@ -2,4 +2,4 @@

    Parameters

    Returns asserts value is JsonMap

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertNonNull.html b/functions/assertNonNull.html index 19bb0777..d5f56c6b 100644 --- a/functions/assertNonNull.html +++ b/functions/assertNonNull.html @@ -9,4 +9,4 @@

    Type Parameters

    Parameters

    Returns asserts value is T

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertNumber.html b/functions/assertNumber.html index d9cf859a..38152828 100644 --- a/functions/assertNumber.html +++ b/functions/assertNumber.html @@ -2,4 +2,4 @@

    Parameters

    Returns asserts value is number

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertObject.html b/functions/assertObject.html index 0c1f9fea..ed04047a 100644 --- a/functions/assertObject.html +++ b/functions/assertObject.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns asserts value is T

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertPlainObject.html b/functions/assertPlainObject.html index 6fd8fda4..044c44fe 100644 --- a/functions/assertPlainObject.html +++ b/functions/assertPlainObject.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns asserts value is T

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/assertString.html b/functions/assertString.html index 9a0ff033..6938cbf7 100644 --- a/functions/assertString.html +++ b/functions/assertString.html @@ -2,4 +2,4 @@

    Parameters

    Returns asserts value is string

    Throws

    AssertionFailedError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/coerceAnyJson.html b/functions/coerceAnyJson.html index 0ecb8055..61a17ac4 100644 --- a/functions/coerceAnyJson.html +++ b/functions/coerceAnyJson.html @@ -4,7 +4,7 @@ function, it's the responsibility of the caller to understand the risks of making such a shallow type assertion over the value data.

    Parameters

    Returns Optional<AnyJson>

  • coerceAnyJson(value, defaultValue): AnyJson

  • Narrows an unknown value to an AnyJson if it is type-compatible, or returns the provided default otherwise.

    +

    • Returns Optional<AnyJson>

  • coerceAnyJson(value, defaultValue): AnyJson

  • Narrows an unknown value to an AnyJson if it is type-compatible, or returns the provided default otherwise.

    Parameters

    Returns AnyJson

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns AnyJson

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/coerceJsonArray.html b/functions/coerceJsonArray.html index 7d439d4d..b8a0cf69 100644 --- a/functions/coerceJsonArray.html +++ b/functions/coerceJsonArray.html @@ -1,12 +1,12 @@ -coerceJsonArray | @salesforce/ts-types

    Function coerceJsonArray

    • coerceJsonArray<T>(value): Optional<JsonArray>

    • Narrows an array of type T to a JsonArray using a shallow type-compatibility check. Use this when the source of +coerceJsonArray | @salesforce/ts-types

      Function coerceJsonArray

      • coerceJsonArray<T>(value): Optional<JsonArray>

      • Narrows an array of type T to a JsonArray using a shallow type-compatibility check. Use this when the source of the array is known to be JSON-compatible and you want simple type coercion to a JsonArray. Use toJsonArray instead when the value array cannot be guaranteed to be JSON-compatible and you want an assurance of runtime type safety. This is a shortcut for writing asJsonArray(coerceAnyJson(value)).

        Type Parameters

        • T

        Parameters

        Returns Optional<JsonArray>

      • coerceJsonArray<T>(value, defaultValue): JsonArray

      • Narrows an array of type T to a JsonArray using a shallow type-compatibility check. Use this when the source of +

      Returns Optional<JsonArray>

    • coerceJsonArray<T>(value, defaultValue): JsonArray

    • Narrows an array of type T to a JsonArray using a shallow type-compatibility check. Use this when the source of the array is known to be JSON-compatible and you want simple type coercion to a JsonArray. Use toJsonArray instead when the value array cannot be guaranteed to be JSON-compatible and you want an assurance of runtime type safety. This is a shortcut for writing asJsonArray(coerceAnyJson(value)) ?? defaultValue.

      Type Parameters

      • T

      Parameters

      • value: Nullable<T[]>

        The array to coerce.

        -
      • defaultValue: JsonArray

        The default to return if value was not defined.

        -

      Returns JsonArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • defaultValue: JsonArray

    The default to return if value was not defined.

    +

    • Returns JsonArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/coerceJsonMap.html b/functions/coerceJsonMap.html index 95892fef..8025194e 100644 --- a/functions/coerceJsonMap.html +++ b/functions/coerceJsonMap.html @@ -3,10 +3,10 @@ instead when the value object cannot be guaranteed to be JSON-compatible and you want an assurance of runtime type safety. This is a shortcut for writing asJsonMap(coerceAnyJson(value)).

    Type Parameters

    Parameters

    Returns Optional<JsonMap>

  • coerceJsonMap<T>(value, defaultValue): JsonMap

  • Narrows an object of type T to a JsonMap using a shallow type-compatibility check. Use this when the source of +

    • Returns Optional<JsonMap>

  • coerceJsonMap<T>(value, defaultValue): JsonMap

  • Narrows an object of type T to a JsonMap using a shallow type-compatibility check. Use this when the source of the object is known to be JSON-compatible and you want simple type coercion to a JsonMap. Use toJsonMap instead when the value object cannot be guaranteed to be JSON-compatible and you want an assurance of runtime type safety. This is a shortcut for writing asJsonMap(coerceAnyJson(value)) ?? defaultValue.

    Type Parameters

    Parameters

    Returns JsonMap

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns JsonMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/definiteEntriesOf.html b/functions/definiteEntriesOf.html index f14d559a..666d045d 100644 --- a/functions/definiteEntriesOf.html +++ b/functions/definiteEntriesOf.html @@ -4,4 +4,4 @@ null values.

    See also caveats outlined in entriesOf.

    Type Parameters

    Parameters

    Returns [K, V][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns [K, V][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/definiteKeysOf.html b/functions/definiteKeysOf.html index f53d8464..7218d63d 100644 --- a/functions/definiteKeysOf.html +++ b/functions/definiteKeysOf.html @@ -2,4 +2,4 @@ This can be convenient for enumerating the keys of definitely assigned properties in an object or Dictionary.

    See also caveats outlined in keysOf.

    Type Parameters

    Parameters

    Returns KeyOf<T>[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns KeyOf<T>[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/definiteValuesOf.html b/functions/definiteValuesOf.html index bbadd8be..b99dd178 100644 --- a/functions/definiteValuesOf.html +++ b/functions/definiteValuesOf.html @@ -2,4 +2,4 @@ This can be convenient for enumerating the values of unknown objects with optional properties (including Dictionarys) without worrying about performing checks against possibly undefined or null values.

    Type Parameters

    Parameters

    Returns NonNullable<T[KeyOf<T>]>[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns NonNullable<T[KeyOf<T>]>[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensure.html b/functions/ensure.html index c2fd4577..a359494b 100644 --- a/functions/ensure.html +++ b/functions/ensure.html @@ -9,4 +9,4 @@

    Type Parameters

    Parameters

    Returns T

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureAnyJson.html b/functions/ensureAnyJson.html index 7f01eebd..09317299 100644 --- a/functions/ensureAnyJson.html +++ b/functions/ensureAnyJson.html @@ -3,4 +3,4 @@

    Parameters

    Returns AnyJson

    Throws

    UnexpectedValueTypeError If the value was not a JSON value type.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureArray.html b/functions/ensureArray.html index 4d21df5e..8b5ad8b4 100644 --- a/functions/ensureArray.html +++ b/functions/ensureArray.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns T[]

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureBoolean.html b/functions/ensureBoolean.html index 1ef63762..864ecea0 100644 --- a/functions/ensureBoolean.html +++ b/functions/ensureBoolean.html @@ -2,4 +2,4 @@

    Parameters

    Returns boolean

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureDictionary.html b/functions/ensureDictionary.html index ca4f4d9b..30d33743 100644 --- a/functions/ensureDictionary.html +++ b/functions/ensureDictionary.html @@ -1,6 +1,6 @@ -ensureDictionary | @salesforce/ts-types

    Function ensureDictionary

    • ensureDictionary<T>(value, message?): Dictionary<T>

    • Narrows an unknown value to a Dictionary<T> if it is type-compatible and tests positively +ensureDictionary | @salesforce/ts-types

      Function ensureDictionary

      • ensureDictionary<T>(value, message?): Dictionary<T>

      • Narrows an unknown value to a Dictionary<T> if it is type-compatible and tests positively with isDictionary, or raises an error otherwise.

        Type Parameters

        • T = unknown

        Parameters

        • value: unknown

          The value to test.

        • Optional message: string

          The error message to use if value is not type-compatible.

          -

        Returns Dictionary<T>

        Throws

        UnexpectedValueTypeError If the value was undefined.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns Dictionary<T>

    Throws

    UnexpectedValueTypeError If the value was undefined.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureFunction.html b/functions/ensureFunction.html index 5321c0fd..0a9a5cc8 100644 --- a/functions/ensureFunction.html +++ b/functions/ensureFunction.html @@ -2,4 +2,4 @@

    Parameters

    Returns AnyFunction

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureInstance.html b/functions/ensureInstance.html index 1072ca0f..991cffe9 100644 --- a/functions/ensureInstance.html +++ b/functions/ensureInstance.html @@ -1,6 +1,6 @@ ensureInstance | @salesforce/ts-types

    Function ensureInstance

    • ensureInstance<C>(value, ctor, message?): InstanceType<C>

    • Narrows an unknown value to instance of constructor type T if it is type-compatible, or raises an error otherwise.

      -

      Type Parameters

      Parameters

      • value: unknown

        The value to test.

        +

        Type Parameters

        Parameters

        • value: unknown

          The value to test.

        • ctor: C
        • Optional message: string

          The error message to use if value is not type-compatible.

        Returns InstanceType<C>

        Throws

        UnexpectedValueTypeError If the value was undefined.

        -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureJsonArray.html b/functions/ensureJsonArray.html index 60d1ec1b..426cdea8 100644 --- a/functions/ensureJsonArray.html +++ b/functions/ensureJsonArray.html @@ -1,5 +1,5 @@ -ensureJsonArray | @salesforce/ts-types

    Function ensureJsonArray

    • ensureJsonArray(value, message?): JsonArray

    • Narrows an AnyJson value to a JsonArray if it is type-compatible, or raises an error otherwise.

      +ensureJsonArray | @salesforce/ts-types

      Function ensureJsonArray

      • ensureJsonArray(value, message?): JsonArray

      • Narrows an AnyJson value to a JsonArray if it is type-compatible, or raises an error otherwise.

        Parameters

        • value: Optional<AnyJson>

          The value to test.

        • Optional message: string

          The error message to use if value is not type-compatible.

          -

        Returns JsonArray

        Throws

        UnexpectedValueTypeError If the value was undefined.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns JsonArray

    Throws

    UnexpectedValueTypeError If the value was undefined.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureJsonMap.html b/functions/ensureJsonMap.html index 6e934429..8ed6511c 100644 --- a/functions/ensureJsonMap.html +++ b/functions/ensureJsonMap.html @@ -2,4 +2,4 @@

    Parameters

    Returns JsonMap

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureNumber.html b/functions/ensureNumber.html index e532f7e1..dc1d3926 100644 --- a/functions/ensureNumber.html +++ b/functions/ensureNumber.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureObject.html b/functions/ensureObject.html index 443393a4..9246bdb7 100644 --- a/functions/ensureObject.html +++ b/functions/ensureObject.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns T

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensurePlainObject.html b/functions/ensurePlainObject.html index 4e91e52e..2d905f2c 100644 --- a/functions/ensurePlainObject.html +++ b/functions/ensurePlainObject.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns T

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/ensureString.html b/functions/ensureString.html index 307ee766..fcff35d7 100644 --- a/functions/ensureString.html +++ b/functions/ensureString.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    Throws

    UnexpectedValueTypeError If the value was undefined.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/entriesOf.html b/functions/entriesOf.html index edb896d0..6dd6fa87 100644 --- a/functions/entriesOf.html +++ b/functions/entriesOf.html @@ -11,4 +11,4 @@ 
    interface Point { x: number; y: number; }
    const point: Point = { x: 1, y: 2 };
    // type of entries -> ['x' | 'y', number][]
    const entries = entriesOf(point);
    for (const entry of entries) {
      console.log(entry[0], entry[1]);
    }
    // x 1
    // y 2

    Type Parameters

    Parameters

    Returns [K, T[K]][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns [K, T[K]][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/get.html b/functions/get.html index b3381240..3b045eae 100644 --- a/functions/get.html +++ b/functions/get.html @@ -4,4 +4,4 @@

    Parameters

    Returns unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getAnyJson.html b/functions/getAnyJson.html index 5a2940ba..a3c3331b 100644 --- a/functions/getAnyJson.html +++ b/functions/getAnyJson.html @@ -5,11 +5,11 @@

    Parameters

    Returns Optional<AnyJson>

  • getAnyJson(from, path, defaultValue): AnyJson

  • Given a deep-search query path, returns an object property or array value of a JsonCollection as an +

    • Returns Optional<AnyJson>

  • getAnyJson(from, path, defaultValue): AnyJson

  • Given a deep-search query path, returns an object property or array value of a JsonCollection as an AnyJson, or the given default if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [{ a: 'b' }] } };
    const value = getAnyJson(obj, 'foo.bar[1]', { c: 'd' });
    // type of value -> AnyJson; value -> { c: 'd' }

    Parameters

    Returns AnyJson

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns AnyJson

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getArray.html b/functions/getArray.html index 2fc59232..8fcf7603 100644 --- a/functions/getArray.html +++ b/functions/getArray.html @@ -1,14 +1,14 @@ -getArray | @salesforce/ts-types

    Function getArray

    • getArray(from, path): Nullable<AnyArray>

    • Given a deep-search query path, returns an object property or array value of an object or array as an -AnyArray, or undefined if a value was not found or was not type-compatible.

      +getArray | @salesforce/ts-types

      Function getArray

      • getArray(from, path): Nullable<AnyArray>

      • Given a deep-search query path, returns an object property or array value of an object or array as an +AnyArray, or undefined if a value was not found or was not type-compatible.

        const obj = { foo: { bar: [1, 2, 3] } };
        const value = getArray(obj, 'foo.bar');
        // type of value -> AnyArray; value -> [1, 2, 3]

        Parameters

        • from: unknown

          Any value to query.

        • path: string

          The query path.

          -

        Returns Nullable<AnyArray>

      • getArray(from, path, defaultValue): AnyArray

      • Given a deep-search query path, returns an object property or array value of an object or array as an -AnyArray, or undefined if a value was not found or was not type-compatible.

        +

      Returns Nullable<AnyArray>

    • getArray(from, path, defaultValue): AnyArray

    • Given a deep-search query path, returns an object property or array value of an object or array as an +AnyArray, or undefined if a value was not found or was not type-compatible.

      const obj = { foo: { bar: [1, 2, 3] } };
      const value = getArray(obj, 'foo.baz', [4, 5, 6]);
      // type of value -> AnyArray; value -> [4, 5, 6]

      Parameters

      • from: unknown

        Any value to query.

      • path: string

        The query path.

        -
      • defaultValue: AnyArray<unknown>

        The default to return if the query result was not defined.

        -

      Returns AnyArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • defaultValue: AnyArray

    The default to return if the query result was not defined.

    +

    • Returns AnyArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getBoolean.html b/functions/getBoolean.html index d75af221..d7c42c67 100644 --- a/functions/getBoolean.html +++ b/functions/getBoolean.html @@ -4,11 +4,11 @@

    Parameters

    Returns Nullable<boolean>

  • getBoolean(from, path, defaultValue): boolean

  • Given a deep-search query path, returns an object property or array value of an object or array as a boolean, or +

    • Returns Nullable<boolean>

  • getBoolean(from, path, defaultValue): boolean

  • Given a deep-search query path, returns an object property or array value of an object or array as a boolean, or undefined if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [true] } };
    const value = getBoolean(obj, 'foo.bar[1]', false);
    // type of value -> boolean; value -> false

    Parameters

    Returns boolean

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getDictionary.html b/functions/getDictionary.html index ac0b756d..2269b499 100644 --- a/functions/getDictionary.html +++ b/functions/getDictionary.html @@ -1,14 +1,14 @@ -getDictionary | @salesforce/ts-types

    Function getDictionary

    • getDictionary<T>(from, path): Nullable<Dictionary<T>>

    • Given a deep-search query path, returns an object property or array value of an object or array as a Dictionary<T>, or +getDictionary | @salesforce/ts-types

      Function getDictionary

      • getDictionary<T>(from, path): Nullable<Dictionary<T>>

      • Given a deep-search query path, returns an object property or array value of an object or array as a Dictionary<T>, or undefined if a value was not found or was not type-compatible.

        const obj = { foo: { bar: [{ name: 'baz' }] } };
        const value = getDictionary<string>(obj, 'foo.bar[0]');
        // type of value -> Dictionary<string>; value -> { name: 'baz' }

        Type Parameters

        • T = unknown

        Parameters

        • from: unknown

          Any value to query.

        • path: string

          The query path.

          -

        Returns Nullable<Dictionary<T>>

      • getDictionary<T>(from, path, defaultValue): Dictionary<T>

      • Given a deep-search query path, returns an object property or array value of an object or array as an Dictionary<T>, or +

      Returns Nullable<Dictionary<T>>

    • getDictionary<T>(from, path, defaultValue): Dictionary<T>

    • Given a deep-search query path, returns an object property or array value of an object or array as an Dictionary<T>, or undefined if a value was not found or was not type-compatible.

      const obj = { foo: { bar: [{ name: 'baz' }] } };
      const value = getDictionary<string>(obj, 'foo.bar[1]', { name: 'buzz' });
      // type of value -> Dictionary<string>; value -> { name: 'buzz' }

      Type Parameters

      • T = unknown

      Parameters

      • from: unknown

        Any value to query.

      • path: string

        The query path.

        -
      • defaultValue: Dictionary<T>

        The default to return if the query result was not defined.

        -

      Returns Dictionary<T>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • defaultValue: Dictionary<T>

    The default to return if the query result was not defined.

    +

    • Returns Dictionary<T>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getFunction.html b/functions/getFunction.html index 821a813a..50f083f9 100644 --- a/functions/getFunction.html +++ b/functions/getFunction.html @@ -4,11 +4,11 @@

    Parameters

    Returns Nullable<AnyFunction>

  • getFunction(from, path, defaultValue): AnyFunction

  • Given a deep-search query path, returns an object property or array value of an object or array as an +

    • Returns Nullable<AnyFunction>

  • getFunction(from, path, defaultValue): AnyFunction

  • Given a deep-search query path, returns an object property or array value of an object or array as an AnyFunction, or undefined if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [(arg: string) => `Hi, ${arg}`] } };
    const value = getFunction(obj, 'foo.bar[1]', (arg: string) => `Bye, ${arg}`);
    // type of value -> AnyArray; value -> (arg: string) => `Bye, ${arg}`)

    Parameters

    Returns AnyFunction

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • defaultValue: AnyFunction

    The default to return if the query result was not defined.

    +

    • Returns AnyFunction

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getInstance.html b/functions/getInstance.html index aecdb5cf..787eeea8 100644 --- a/functions/getInstance.html +++ b/functions/getInstance.html @@ -2,13 +2,13 @@ class type C, or undefined if a value was not found or was not type-compatible.

    class Example { ... }
    const obj = { foo: { bar: [new Example()] } };
    const value = getInstance(obj, 'foo.bar[0]', Example);
    // type of value -> Example
    -

    Type Parameters

    Parameters

    Returns Nullable<InstanceType<C>>

  • getInstance<C>(from, path, ctor, defaultValue): InstanceType<C>

  • Given a deep-search query path, returns an object property or array value of an object or array as an instance of class type C, or undefined if a value was not found or was not type-compatible.

    class Example { ... }
    const obj = { foo: { bar: [new Example()] } };
    const value = getInstance(obj, 'foo.bar[0]', Example);
    // type of value -> Example; value -> new Example()
    -

    Type Parameters

    Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    • Returns InstanceType<C>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getJsonArray.html b/functions/getJsonArray.html index 397b5746..26b8da5d 100644 --- a/functions/getJsonArray.html +++ b/functions/getJsonArray.html @@ -1,14 +1,14 @@ -getJsonArray | @salesforce/ts-types

    Function getJsonArray

    • getJsonArray(from, path): Nullable<JsonArray>

    • Given a deep-search query path, returns an object property or array value from an AnyJson as a -JsonArray, or undefined if a value was not found or was not type-compatible.

      +getJsonArray | @salesforce/ts-types

      Function getJsonArray

      • getJsonArray(from, path): Nullable<JsonArray>

      • Given a deep-search query path, returns an object property or array value from an AnyJson as a +JsonArray, or undefined if a value was not found or was not type-compatible.

        const obj = { foo: { bar: [1, 2, 3] } };
        const value = getJsonArray(obj, 'foo.bar');
        // type of value -> JsonArray; value -> [1, 2, 3]

        Parameters

        • from: Optional<AnyJson>

          The JSON value to query.

        • path: string

          The query path.

          -

        Returns Nullable<JsonArray>

      • getJsonArray(from, path, defaultValue): JsonArray

      • Given a deep-search query path, returns an object property or array value from an AnyJson as a -JsonArray, or the given default if a value was not found or was not type-compatible.

        +

      Returns Nullable<JsonArray>

    • getJsonArray(from, path, defaultValue): JsonArray

    • Given a deep-search query path, returns an object property or array value from an AnyJson as a +JsonArray, or the given default if a value was not found or was not type-compatible.

      const obj = { foo: { bar: [1, 2, 3] } };
      const value = getJsonArray(obj, 'foo.baz', [4, 5, 6]);
      // type of value -> JsonArray; value -> [4, 5, 6]

      Parameters

      • from: Optional<AnyJson>

        The JSON value to query.

      • path: string

        The query path.

        -
      • defaultValue: JsonArray

        The default to return if the query result was not defined.

        -

      Returns JsonArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • defaultValue: JsonArray

    The default to return if the query result was not defined.

    +

    • Returns JsonArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getJsonMap.html b/functions/getJsonMap.html index f011fc30..3f513633 100644 --- a/functions/getJsonMap.html +++ b/functions/getJsonMap.html @@ -4,11 +4,11 @@

    Parameters

    Returns Nullable<JsonMap>

  • getJsonMap(from, path, defaultValue): JsonMap

  • Given a deep-search query path, returns an object property or array value from an AnyJson as a +

    • Returns Nullable<JsonMap>

  • getJsonMap(from, path, defaultValue): JsonMap

  • Given a deep-search query path, returns an object property or array value from an AnyJson as a JsonMap, or the given default if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [{ a: 'b' }] } };
    const value = getJsonMap(obj, 'foo.bar[1]', { c: 'd' });
    // type of value -> JsonMap; value -> { c: 'd' }

    Parameters

    Returns JsonMap

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns JsonMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getNumber.html b/functions/getNumber.html index 6b4267fd..d948b263 100644 --- a/functions/getNumber.html +++ b/functions/getNumber.html @@ -4,11 +4,11 @@

    Parameters

    Returns Nullable<number>

  • getNumber(from, path, defaultValue): number

  • Given a deep-search query path, returns an object property or array value of an object or array as a number, or +

    • Returns Nullable<number>

  • getNumber(from, path, defaultValue): number

  • Given a deep-search query path, returns an object property or array value of an object or array as a number, or undefined if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [1] } };
    const value = getNumber(obj, 'foo.bar[1]', 2);
    // type of value -> number; value -> 2

    Parameters

    Returns number

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getObject.html b/functions/getObject.html index 69fabd9e..9a55647d 100644 --- a/functions/getObject.html +++ b/functions/getObject.html @@ -4,11 +4,11 @@

    Type Parameters

    Parameters

    Returns Nullable<T>

  • getObject<T>(from, path, defaultValue): T

  • Given a deep-search query path, returns an object property or array value of an object or array as an object, or +

    • Returns Nullable<T>

  • getObject<T>(from, path, defaultValue): T

  • Given a deep-search query path, returns an object property or array value of an object or array as an object, or undefined if a value was not found or was not type-compatible.

    const obj = { foo: { bar: [{ name: 'baz' }] } };
    const value = getObject(obj, 'foo.bar[1]', { name: 'buzz' });
    // type of value -> object; value -> { name: 'buzz' }

    Type Parameters

    Parameters

    Returns T

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getPlainObject.html b/functions/getPlainObject.html index ebe21970..e7b0152f 100644 --- a/functions/getPlainObject.html +++ b/functions/getPlainObject.html @@ -5,7 +5,7 @@

    Type Parameters

    Parameters

    Returns Nullable<T>

  • getPlainObject<T>(from, path, defaultValue): T

  • Given a deep-search query path, returns an object property or array value of an object or array as an object, or +

    • Returns Nullable<T>

  • getPlainObject<T>(from, path, defaultValue): T

  • Given a deep-search query path, returns an object property or array value of an object or array as an object, or undefined if a value was not found or was not type-compatible. This differs from getObject by way of testing for the property value type compatibility using isPlainObject instead of isObject.

    const obj = { foo: { bar: [{ name: 'baz' }] } };
    const value = getPlainObject(obj, 'foo.bar[1]', { name: 'buzz' });
    // type of value -> object; value -> { name: 'buzz' }
@@ -13,4 +13,4 @@

    Type Parameters

    Parameters

    Returns T

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getString.html b/functions/getString.html index 1c52ae67..bc6ec43b 100644 --- a/functions/getString.html +++ b/functions/getString.html @@ -4,11 +4,11 @@

    Parameters

    Returns Nullable<string>

  • getString(from, path, defaultValue): string

  • Given a deep-search query path, returns an object property or array value of an object or array as a string, or +

    • Returns Nullable<string>

  • getString(from, path, defaultValue): string

  • Given a deep-search query path, returns an object property or array value of an object or array as a string, or undefined if a value was not found or was not type-compatible.

    const obj = { foo: { bar: ['baz'] } };
    const value = getString(obj, 'foo.bar[1]', 'default');
    // type of value -> string; value -> 'default'

    Parameters

    Returns string

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/has.html b/functions/has.html index 918e3a4c..19fbe594 100644 --- a/functions/has.html +++ b/functions/has.html @@ -1,4 +1,4 @@ -has | @salesforce/ts-types

    Function has

    • has<T, K>(value, keys): value is T & object & View<K, unknown>

    • Tests whether a value of type T contains one or more property keys. If so, the type of the tested value is +has | @salesforce/ts-types

      Function has

      • has<T, K>(value, keys): value is T & object & View<K>

      • Tests whether a value of type T contains one or more property keys. If so, the type of the tested value is narrowed to reflect the existence of those keys for convenient access in the same scope. Returns false if the property key does not exist on the target type, which must be an object. Returns true if the property key exists, even if the associated value is undefined or null.

        @@ -6,4 +6,4 @@

        Type Parameters

        • T
        • K extends string

        Parameters

        • value: T

          The value to test.

        • keys: Many<K>

          One or more string keys to check for existence.

          -

        Returns value is T & object & View<K, unknown>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns value is T & object & View<K>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasAnyJson.html b/functions/hasAnyJson.html index 10659b83..f34c4dc9 100644 --- a/functions/hasAnyJson.html +++ b/functions/hasAnyJson.html @@ -6,4 +6,4 @@ 
    // type of obj -> unknown
    if (hasAnyJson(obj, 'body')) {
      // type of obj -> { body: AnyJson }
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, AnyJson>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, AnyJson>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasArray.html b/functions/hasArray.html index 38c86247..89167c67 100644 --- a/functions/hasArray.html +++ b/functions/hasArray.html @@ -1,7 +1,7 @@ -hasArray | @salesforce/ts-types

    Function hasArray

    • hasArray<T, K>(value, key): value is T & object & View<K, AnyArray<unknown>>

    • Tests whether a value of type T contains a property key of type AnyArray. If so, the type of the tested +hasArray | @salesforce/ts-types

      Function hasArray

      • hasArray<T, K>(value, key): value is T & object & View<K, AnyArray>

      • Tests whether a value of type T contains a property key of type AnyArray. If so, the type of the tested value is narrowed to reflect the existence of that key for convenient access in the same scope. Returns false if -the property key does not exist on the object or the value stored by that key is not of type AnyArray.

        +the property key does not exist on the object or the value stored by that key is not of type AnyArray.

        // type of obj -> unknown
        if (hasNumber(obj, 'offset')) {
          // type of obj -> { offset: number }
          if (hasNumber(obj, 'page') && hasArray(obj, 'items')) {
            // type of obj -> { offset: number } & { page: number } & { items: AnyArray }
          }
        }

        Type Parameters

        • T
        • K extends string

        Parameters

        Returns value is T & object & View<K, AnyArray<unknown>>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +
    • key: K

    Returns value is T & object & View<K, AnyArray>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasBoolean.html b/functions/hasBoolean.html index a6f65630..991c7901 100644 --- a/functions/hasBoolean.html +++ b/functions/hasBoolean.html @@ -4,4 +4,4 @@ 
    // type of obj -> unknown
    if (hasBoolean(obj, 'enabled')) {
      // type of obj -> { enabled: boolean }
      if (hasBoolean(obj, 'hidden')) {
        // type of obj -> { enabled: boolean } & { hidden: boolean }
      }
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, boolean>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, boolean>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasDictionary.html b/functions/hasDictionary.html index 3141ecb4..7eca2a45 100644 --- a/functions/hasDictionary.html +++ b/functions/hasDictionary.html @@ -1,8 +1,8 @@ -hasDictionary | @salesforce/ts-types

    Function hasDictionary

    • hasDictionary<V, T, K>(value, key): value is T & object & View<K, Dictionary<V>>

    • Tests whether a value of type T contains a property key whose type tests positively when tested with +hasDictionary | @salesforce/ts-types

      Function hasDictionary

      • hasDictionary<V, T, K>(value, key): value is T & object & View<K, Dictionary<V>>

      • Tests whether a value of type T contains a property key whose type tests positively when tested with isDictionary. If so, the type of the tested value is narrowed to reflect the existence of that key for convenient access in the same scope. Returns false if the property key does not exist on the object or the value stored by that key is not of type object.

        // type of obj -> unknown
        if (hasNumber(obj, 'status')) {
          // type of obj -> { status: number }
          if (hasDictionary(obj, 'data')) {
            // type of obj -> { status: number } & { data: Dictionary }
          } else if (hasString('error')) {
            // type of obj -> { status: number } & { error: string }
          }
        }

        Type Parameters

        • V = unknown
        • T = unknown
        • K extends string = string

        Parameters

        • value: T

          The value to test.

          -
        • key: K

        Returns value is T & object & View<K, Dictionary<V>>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +
    • key: K

    Returns value is T & object & View<K, Dictionary<V>>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasFunction.html b/functions/hasFunction.html index 58e8736d..66606f5f 100644 --- a/functions/hasFunction.html +++ b/functions/hasFunction.html @@ -1,8 +1,8 @@ -hasFunction | @salesforce/ts-types

    Function hasFunction

    • hasFunction<T, K>(value, key): value is T & object & View<K, AnyFunction<unknown>>

    • Tests whether a value of type T contains a property key of type AnyFunction. If so, the type of the +hasFunction | @salesforce/ts-types

      Function hasFunction

      • hasFunction<T, K>(value, key): value is T & object & View<K, AnyFunction>

      • Tests whether a value of type T contains a property key of type AnyFunction. If so, the type of the tested value is narrowed to reflect the existence of that key for convenient access in the same scope. Returns false if the property key does not exist on the object or the value stored by that key is not of type AnyFunction.

        // type of obj -> unknown
        if (hasFunction(obj, 'callback')) {
          // type of obj -> { callback: AnyFunction }
          obj.callback(response);
        }

        Type Parameters

        • T
        • K extends string

        Parameters

        Returns value is T & object & View<K, AnyFunction<unknown>>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +
    • key: K

    Returns value is T & object & View<K, AnyFunction>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasInstance.html b/functions/hasInstance.html index d5d8acc0..10830c46 100644 --- a/functions/hasInstance.html +++ b/functions/hasInstance.html @@ -4,5 +4,5 @@ property key does not exist on the object or the value stored by that key is not an instance of C.

    class ServerResponse { ... }
    // type of obj -> unknown
    if (hasNumber(obj, 'status')) {
      // type of obj -> { status: number }
      if (hasInstance(obj, 'data', ServerResponse)) {
        // type of obj -> { status: number } & { data: ServerResponse }
      } else if (hasString('error')) {
        // type of obj -> { status: number } & { error: string }
      }
    }
    -

    Type Parameters

    Parameters

    Returns value is T & View<K, InstanceType<C>>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns value is T & View<K, InstanceType<C>>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasJsonArray.html b/functions/hasJsonArray.html index 3d2ab001..7e0f6b52 100644 --- a/functions/hasJsonArray.html +++ b/functions/hasJsonArray.html @@ -1,8 +1,8 @@ -hasJsonArray | @salesforce/ts-types

    Function hasJsonArray

    • hasJsonArray<T, K>(value, key): value is T & JsonMap & View<K, JsonArray>

    • Tests whether a value of type T extends AnyJson contains a property key of type JsonArray. If so, the +hasJsonArray | @salesforce/ts-types

      Function hasJsonArray

      • hasJsonArray<T, K>(value, key): value is T & JsonMap & View<K, JsonArray>

      • Tests whether a value of type T extends AnyJson contains a property key of type JsonArray. If so, the type of the tested value is narrowed to reflect the existence of that key for convenient access in the same scope. Returns false if the property key does not exist on the object or the value stored by that key is not of type -JsonArray.

        +JsonArray.

        // type of obj -> unknown
        if (hasJsonArray(obj, 'body')) {
          // type of obj -> { body: JsonArray }
        }

        Type Parameters

        Parameters

        Returns value is T & JsonMap & View<K, JsonArray>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +
    • key: K

    Returns value is T & JsonMap & View<K, JsonArray>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasJsonMap.html b/functions/hasJsonMap.html index c7a7718e..6f5193d4 100644 --- a/functions/hasJsonMap.html +++ b/functions/hasJsonMap.html @@ -5,4 +5,4 @@ 
    // type of obj -> unknown
    if (hasJsonMap(obj, 'body')) {
      // type of obj -> { body: JsonMap }
    }

    Type Parameters

    Parameters

    Returns value is T & JsonMap & View<K, JsonMap>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & JsonMap & View<K, JsonMap>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasNumber.html b/functions/hasNumber.html index cb5583ff..49b15043 100644 --- a/functions/hasNumber.html +++ b/functions/hasNumber.html @@ -4,4 +4,4 @@ 
    // type of obj -> unknown
    if (hasNumber(obj, 'offset')) {
      // type of obj -> { offset: number }
      if (hasNumber(obj, 'page') && hasArray(obj, 'items')) {
        // type of obj -> { offset: number } & { page: number } & { items: unknown[] }
      }
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, number>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, number>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasObject.html b/functions/hasObject.html index 23d2583b..4523ada6 100644 --- a/functions/hasObject.html +++ b/functions/hasObject.html @@ -4,4 +4,4 @@ 
    // type of obj -> unknown
    if (hasNumber(obj, 'status')) {
      // type of obj -> { status: number }
      if (hasObject(obj, 'data')) {
        // type of obj -> { status: number } & { data: object }
      } else if (hasString('error')) {
        // type of obj -> { status: number } & { error: string }
      }
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, V>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, V>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasPlainObject.html b/functions/hasPlainObject.html index e133226d..04189a40 100644 --- a/functions/hasPlainObject.html +++ b/functions/hasPlainObject.html @@ -5,4 +5,4 @@ 
    // type of obj -> unknown
    if (hasNumber(obj, 'status')) {
      // type of obj -> { status: number }
      if (hasPlainObject(obj, 'data')) {
        // type of obj -> { status: number } & { data: object }
      } else if (hasString('error')) {
        // type of obj -> { status: number } & { error: string }
      }
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, V>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, V>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/hasString.html b/functions/hasString.html index 2da8e406..f7385781 100644 --- a/functions/hasString.html +++ b/functions/hasString.html @@ -4,4 +4,4 @@ 
    // type of obj -> unknown
    if (hasString(obj, 'name')) {
      // type of obj -> { name: string }
      if (hasString(obj, 'message')) {
        // type of obj -> { name: string } & { message: string }
      }
    }

    Type Parameters

    Parameters

    Returns value is T & object & View<K, string>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • key: K

    • Returns value is T & object & View<K, string>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isAnyJson.html b/functions/isAnyJson.html index 7ffd4950..796e0b92 100644 --- a/functions/isAnyJson.html +++ b/functions/isAnyJson.html @@ -1,4 +1,4 @@ isAnyJson | @salesforce/ts-types

    Function isAnyJson

    • isAnyJson(value): value is AnyJson

    • Tests whether unknown value is a valid JSON type. Note that objects and arrays are only checked using a shallow test. To be sure that a given value is JSON-compatible at runtime, see toAnyJson.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns value is AnyJson

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is AnyJson

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isArray.html b/functions/isArray.html index 2879c804..d875af81 100644 --- a/functions/isArray.html +++ b/functions/isArray.html @@ -7,4 +7,4 @@ shape T. Use of the functions in the has co-library are useful for performing such full or partial proofs.

    Type Parameters

    Parameters

    Returns value is T[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is T[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isArrayLike.html b/functions/isArrayLike.html index c9c96b30..6113d38e 100644 --- a/functions/isArrayLike.html +++ b/functions/isArrayLike.html @@ -1,4 +1,4 @@ -isArrayLike | @salesforce/ts-types

    Function isArrayLike

    • isArrayLike<T>(value): value is ArrayLike<T>

    • Tests whether an unknown value conforms to AnyArrayLike.

      +isArrayLike | @salesforce/ts-types

      Function isArrayLike

      • isArrayLike<T>(value): value is ArrayLike<T>

      • Tests whether an unknown value conforms to AnyArrayLike.

        Use of the type parameter T to further narrow the type signature of the value being tested is strongly discouraged unless you are completely confident that the value is of the necessary shape to conform with T. This function does nothing at either compile time or runtime to prove the value is of @@ -7,4 +7,4 @@ shape T. Use of the functions in the has co-library are useful for performing such full or partial proofs.

        Type Parameters

        • T = unknown

        Parameters

        • value: unknown

          The value to test.

          -

        Returns value is ArrayLike<T>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns value is ArrayLike<T>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isBoolean.html b/functions/isBoolean.html index f1cafa3f..c1b08b32 100644 --- a/functions/isBoolean.html +++ b/functions/isBoolean.html @@ -1,3 +1,3 @@ isBoolean | @salesforce/ts-types

    Function isBoolean

    • isBoolean(value): value is boolean

    • Tests whether an unknown value is a boolean.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns value is boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isClassAssignableTo.html b/functions/isClassAssignableTo.html index 7865bbd0..21a03858 100644 --- a/functions/isClassAssignableTo.html +++ b/functions/isClassAssignableTo.html @@ -1,5 +1,5 @@ isClassAssignableTo | @salesforce/ts-types

    Function isClassAssignableTo

    • isClassAssignableTo<C>(value, cls): value is C

    • Tests whether an unknown value is a class constructor that is either equal to or extends another class constructor.

      -

      Type Parameters

      Parameters

      • value: unknown

        The value to test.

        +

        Type Parameters

        Parameters

        • value: unknown

          The value to test.

        • cls: C

          The class to test against.

          -

        Returns value is C

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is C

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isDictionary.html b/functions/isDictionary.html index 130594ea..160702d6 100644 --- a/functions/isDictionary.html +++ b/functions/isDictionary.html @@ -1,4 +1,4 @@ -isDictionary | @salesforce/ts-types

    Function isDictionary

    • isDictionary<T>(value): value is Dictionary<T>

    • A shortcut for testing the suitability of a value to be used as a Dictionary<T> type. Shorthand for +isDictionary | @salesforce/ts-types

      Function isDictionary

      • isDictionary<T>(value): value is Dictionary<T>

      • A shortcut for testing the suitability of a value to be used as a Dictionary<T> type. Shorthand for writing isPlainObject<Dictionary<T>>(value). While some non-plain-object types are compatible with index signatures, they were less typically used as such, so this function focuses on the 80% case.

        Use of the type parameter T to further narrow the type signature of the value being tested is @@ -9,4 +9,4 @@ shape T. Use of the functions in the has co-library are useful for performing such full or partial proofs.

        Type Parameters

        • T = unknown

        Parameters

        • value: unknown

          The value to test.

          -

        Returns value is Dictionary<T>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns value is Dictionary<T>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isFunction.html b/functions/isFunction.html index d3052bce..2c803445 100644 --- a/functions/isFunction.html +++ b/functions/isFunction.html @@ -1,3 +1,3 @@ isFunction | @salesforce/ts-types

    Function isFunction

    • isFunction<T>(value): value is T

    • Tests whether an unknown value is a function.

      -

      Type Parameters

      Parameters

      • value: unknown

        The value to test.

        -

      Returns value is T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns value is T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isInstance.html b/functions/isInstance.html index 6c9327c2..76839745 100644 --- a/functions/isInstance.html +++ b/functions/isInstance.html @@ -1,3 +1,3 @@ isInstance | @salesforce/ts-types

    Function isInstance

    • isInstance<C>(value, ctor): value is InstanceType<C>

    • Tests whether an unknown value is a function.

      -

      Type Parameters

      Parameters

      • value: unknown

        The value to test.

        -
      • ctor: C

      Returns value is InstanceType<C>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns value is InstanceType<C>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isJsonArray.html b/functions/isJsonArray.html index af154fa4..89000cb9 100644 --- a/functions/isJsonArray.html +++ b/functions/isJsonArray.html @@ -1,3 +1,3 @@ -isJsonArray | @salesforce/ts-types

    Function isJsonArray

    • isJsonArray(value): value is JsonArray

    • Tests whether an AnyJson value is an array.

      +isJsonArray | @salesforce/ts-types

      Function isJsonArray

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns value is JsonArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isJsonMap.html b/functions/isJsonMap.html index 98e8cb87..8e390415 100644 --- a/functions/isJsonMap.html +++ b/functions/isJsonMap.html @@ -1,3 +1,3 @@ isJsonMap | @salesforce/ts-types

    Function isJsonMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is JsonMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isKeyOf.html b/functions/isKeyOf.html index 7bd01c78..290af443 100644 --- a/functions/isKeyOf.html +++ b/functions/isKeyOf.html @@ -1,4 +1,4 @@ isKeyOf | @salesforce/ts-types

    Function isKeyOf

    • isKeyOf<T, K>(obj, key): key is K

    • Tests whether or not a key string is a key of the given object type T.

      Type Parameters

      • T extends object
      • K extends string

      Parameters

      • obj: T

        The target object to check the key in.

      • key: string

        The string to test as a key of the target object.

        -

      Returns key is K

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns key is K

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isNumber.html b/functions/isNumber.html index 5be2dee9..a0224c92 100644 --- a/functions/isNumber.html +++ b/functions/isNumber.html @@ -1,3 +1,3 @@ isNumber | @salesforce/ts-types

    Function isNumber

    • isNumber(value): value is number

    • Tests whether an unknown value is a number.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns value is number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isObject.html b/functions/isObject.html index a72fc8bd..d2a2d64e 100644 --- a/functions/isObject.html +++ b/functions/isObject.html @@ -10,4 +10,4 @@ shape T. Use of the functions in the has co-library are useful for performing such full or partial proofs.

    Type Parameters

    Parameters

    Returns value is T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isPlainObject.html b/functions/isPlainObject.html index 737a65a7..684ede90 100644 --- a/functions/isPlainObject.html +++ b/functions/isPlainObject.html @@ -8,4 +8,4 @@ shape T. Use of the functions in the has co-library are useful for performing such full or partial proofs.

    Type Parameters

    Parameters

    Returns value is T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isString.html b/functions/isString.html index c7c48c4d..ea5acbfe 100644 --- a/functions/isString.html +++ b/functions/isString.html @@ -1,3 +1,3 @@ isString | @salesforce/ts-types

    Function isString

    • isString(value): value is string

    • Tests whether an unknown value is a string.

      Parameters

      • value: unknown

        The value to test.

        -

      Returns value is string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns value is string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/keysOf.html b/functions/keysOf.html index 3c02b6a9..6162e707 100644 --- a/functions/keysOf.html +++ b/functions/keysOf.html @@ -11,4 +11,4 @@ 
    interface Point { x: number; y: number; }
    const point: Point = { x: 1, y: 2 };
    const keys = keysOf(point);
    // type of keys -> ('a' | 'b')[]
    for (const key of keys) {
      console.log(key, point[key]);
    }
    // x 1
    // y 2

    Type Parameters

    Parameters

    Returns K[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns K[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/toAnyJson.html b/functions/toAnyJson.html index 29e5af50..16b2165a 100644 --- a/functions/toAnyJson.html +++ b/functions/toAnyJson.html @@ -7,7 +7,7 @@ and only needs type coercion.

    Type Parameters

    Parameters

    Returns Optional<AnyJson>

    Throws

    JsonCloneError If the value values contain circular references.

    -
  • toAnyJson<T>(value, defaultValue): AnyJson

  • Narrows an object of type T to an AnyJson following a deep, brute-force conversion of the object's data to +

  • toAnyJson<T>(value, defaultValue): AnyJson

  • Narrows an object of type T to an AnyJson following a deep, brute-force conversion of the object's data to only consist of JSON-compatible values by performing a basic JSON clone on the object. This is preferable to using the weaker coerceAnyJson(unknown) to type-narrow an arbitrary value to an AnyJson when the value's source is unknown, but it comes with the increased overhead of performing the deep JSON clone to ensure runtime type @@ -17,4 +17,4 @@

    Type Parameters

    Parameters

    Returns AnyJson

    Throws

    JsonCloneError If the value values contain circular references.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/toJsonArray.html b/functions/toJsonArray.html index 90ec7ff0..b7caf17f 100644 --- a/functions/toJsonArray.html +++ b/functions/toJsonArray.html @@ -1,4 +1,4 @@ -toJsonArray | @salesforce/ts-types

    Function toJsonArray

    • toJsonArray<T>(value): JsonArray

    • Narrows an array of type T to a JsonArray following a deep, brute-force conversion of the array's data to +toJsonArray | @salesforce/ts-types

      Function toJsonArray

      • toJsonArray<T>(value): JsonArray

      • Narrows an array of type T to a JsonArray following a deep, brute-force conversion of the array's data to only consist of JSON-compatible values by performing a basic JSON clone on the array. This is preferable to using the weaker coerceJsonArray(array) to type-narrow an arbitrary array to a JsonArray when the array's source is unknown, but it comes with the increased overhead of performing the deep JSON clone to ensure runtime type @@ -6,8 +6,8 @@ JSON data structure. Non-JSON entries will be converted to nulls. Use coerceJsonArray(array) when the value object can be guaranteed to be JSON-compatible and only needs type coercion.

        Type Parameters

        • T

        Parameters

        • value: T[]

          The array to convert.

          -

        Returns JsonArray

        Throws

        JsonCloneError If the array values contain circular references.

        -
      • toJsonArray<T>(value): Optional<JsonArray>

      • Narrows an array of type T to a JsonArray following a deep, brute-force conversion of the array's data to +

      Returns JsonArray

      Throws

      JsonCloneError If the array values contain circular references.

      +
    • toJsonArray<T>(value): Optional<JsonArray>

    • Narrows an array of type T to a JsonArray following a deep, brute-force conversion of the array's data to only consist of JSON-compatible values by performing a basic JSON clone on the array. This is preferable to using the weaker coerceJsonArray(array) to type-narrow an arbitrary array to a JsonArray when the array's source is unknown, but it comes with the increased overhead of performing the deep JSON clone to ensure runtime type @@ -15,8 +15,8 @@ JSON data structure. Non-JSON entries will be converted to nulls. Use coerceJsonArray(array) when the value object can be guaranteed to be JSON-compatible and only needs type coercion.

      Type Parameters

      • T

      Parameters

      Returns Optional<JsonArray>

      Throws

      JsonCloneError If the array values contain circular references.

      -
    • toJsonArray<T>(value, defaultValue): JsonArray

    • Narrows an object of type T to a JsonMap following a deep, brute-force conversion of the object's data to +

    Returns Optional<JsonArray>

    Throws

    JsonCloneError If the array values contain circular references.

    +
  • toJsonArray<T>(value, defaultValue): JsonArray

  • Narrows an object of type T to a JsonMap following a deep, brute-force conversion of the object's data to only consist of JSON-compatible values by performing a basic JSON clone on the object. This is preferable to using the weaker coerceJsonMap(object) to type-narrow an arbitrary array to a JsonMap when the object's source is unknown, but it comes with the increased overhead of performing the deep JSON clone to ensure runtime type @@ -24,6 +24,6 @@ JSON data structure. Non-JSON entries will be converted to nulls. Use coerceJsonArray(array) when the value object can be guaranteed to be JSON-compatible and only needs type coercion.

    Type Parameters

    • T

    Parameters

    • value: Optional<T[]>

      The array to convert.

      -
    • defaultValue: JsonArray

      The default to return if the value was undefined or of the incorrect type.

      -

    Returns JsonArray

    Throws

    JsonCloneError If the array values contain circular references.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • defaultValue: JsonArray

    The default to return if the value was undefined or of the incorrect type.

    +

    • Returns JsonArray

    Throws

    JsonCloneError If the array values contain circular references.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/toJsonMap.html b/functions/toJsonMap.html index 8ca304ae..d37a3d54 100644 --- a/functions/toJsonMap.html +++ b/functions/toJsonMap.html @@ -7,7 +7,7 @@ and only needs type coercion.

    Type Parameters

    Parameters

    Returns JsonMap

    Throws

    JsonCloneError If the object values contain circular references.

    -
  • toJsonMap<T>(value): Optional<JsonMap>

  • Narrows an object of type T to a JsonMap following a deep, brute-force conversion of the object's data to +

  • toJsonMap<T>(value): Optional<JsonMap>

  • Narrows an object of type T to a JsonMap following a deep, brute-force conversion of the object's data to only consist of JSON-compatible values by performing a basic JSON clone on the object. This is preferable to using the weaker coerceJsonMap(object) to type-narrow an arbitrary object to a JsonMap when the object's source is unknown, but it comes with the increased overhead of performing the deep JSON clone to ensure runtime type @@ -16,7 +16,7 @@ and only needs type coercion.

    Type Parameters

    Parameters

    Returns Optional<JsonMap>

    Throws

    JsonCloneError If the object values contain circular references.

    -
  • toJsonMap<T>(value, defaultValue): JsonMap

  • Narrows an object of type T to a JsonMap following a deep, brute-force conversion of the object's data to +

  • toJsonMap<T>(value, defaultValue): JsonMap

  • Narrows an object of type T to a JsonMap following a deep, brute-force conversion of the object's data to only consist of JSON-compatible values by performing a basic JSON clone on the object. This is preferable to using the weaker coerceJsonMap(object) to type-narrow an arbitrary object to a JsonMap when the object's source is unknown, but it comes with the increased overhead of performing the deep JSON clone to ensure runtime type @@ -26,4 +26,4 @@

    Type Parameters

    Parameters

    Returns JsonMap

    Throws

    JsonCloneError If the object values contain circular references.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/valuesOf.html b/functions/valuesOf.html index 72976115..3b0f4d99 100644 --- a/functions/valuesOf.html +++ b/functions/valuesOf.html @@ -11,4 +11,4 @@ 
    interface Point { x: number; y: number; }
    const point: Point = { x: 1, y: 2 };
    const values = valuesOf(point);
    // type of values -> number[]
    for (const value of values) {
      console.log(value);
    }
    // 1
    // 2

    Type Parameters

    Parameters

    Returns T[K][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns T[K][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/hierarchy.html b/hierarchy.html deleted file mode 100644 index c19cc970..00000000 --- a/hierarchy.html +++ /dev/null @@ -1 +0,0 @@ -@salesforce/ts-types

    @salesforce/ts-types

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/AnyArray.html b/interfaces/AnyArray.html deleted file mode 100644 index 4a4b1257..00000000 --- a/interfaces/AnyArray.html +++ /dev/null @@ -1,2 +0,0 @@ -AnyArray | @salesforce/ts-types

    Interface AnyArray<T>

    An alias for an array of T elements, where T defaults to unknown.

    -
    interface AnyArray<T> {}

    Type Parameters

    • T = unknown

    Hierarchy

    • Array<T>
      • AnyArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/AnyArrayLike.html b/interfaces/AnyArrayLike.html deleted file mode 100644 index d7427b97..00000000 --- a/interfaces/AnyArrayLike.html +++ /dev/null @@ -1,3 +0,0 @@ -AnyArrayLike | @salesforce/ts-types

    Interface AnyArrayLike<T>

    Any object with both a numeric index signature with values of type T and a numeric length -property. T defaults to unknown if unspecified.

    -
    interface AnyArrayLike<T> {}

    Type Parameters

    • T = unknown

    Hierarchy

    • ArrayLike<T>
      • AnyArrayLike

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/Dictionary.html b/interfaces/Dictionary.html deleted file mode 100644 index 4423502f..00000000 --- a/interfaces/Dictionary.html +++ /dev/null @@ -1,5 +0,0 @@ -Dictionary | @salesforce/ts-types

    Interface Dictionary<T>

    An object with arbitrary string-indexed values of an optional generic type Optional<T>. T defaults to unknown -when not explicitly supplied. For convenient iteration of definitely assigned (i.e. non-nullable) entries, keys, -and values, see the following functions: definiteEntriesOf, definiteKeysOf, and -definiteValuesOf.

    -
    interface Dictionary<T> {
        [key: string]: Optional<T>;
    }

    Type Parameters

    • T = unknown

    Hierarchy (view full)

    Indexable

    [key: string]: Optional<T>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/JsonArray.html b/interfaces/JsonArray.html deleted file mode 100644 index c8109e51..00000000 --- a/interfaces/JsonArray.html +++ /dev/null @@ -1,2 +0,0 @@ -JsonArray | @salesforce/ts-types

    Interface JsonArray

    Any JSON-compatible array.

    -
    interface JsonArray {}

    Hierarchy

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/JsonMap.html b/interfaces/JsonMap.html index 38aae512..105ea488 100644 --- a/interfaces/JsonMap.html +++ b/interfaces/JsonMap.html @@ -1,2 +1,2 @@ JsonMap | @salesforce/ts-types

    Interface JsonMap

    Any JSON-compatible object.

    -
    interface JsonMap {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
    interface JsonMap {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/modules.html b/modules.html index 7b303fd6..cccf2dfb 100644 --- a/modules.html +++ b/modules.html @@ -1,11 +1,11 @@ -@salesforce/ts-types

    @salesforce/ts-types

    Index

    Interfaces

    AnyArray -AnyArrayLike -Dictionary -JsonArray -JsonMap -

    Type Aliases

    AnyConstructor +@salesforce/ts-types

    @salesforce/ts-types

    Index

    Interfaces

    JsonMap +

    Type Aliases

    AnyArray +AnyArrayLike +AnyConstructor AnyFunction AnyJson +Dictionary +JsonArray JsonCollection JsonPrimitive KeyOf diff --git a/types/AnyArray.html b/types/AnyArray.html new file mode 100644 index 00000000..760ce29d --- /dev/null +++ b/types/AnyArray.html @@ -0,0 +1,2 @@ +AnyArray | @salesforce/ts-types

    Type alias AnyArray<T>

    AnyArray<T>: T[]

    An alias for an array of T elements, where T defaults to unknown.

    +

    Type Parameters

    • T = unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/AnyArrayLike.html b/types/AnyArrayLike.html new file mode 100644 index 00000000..8c31083c --- /dev/null +++ b/types/AnyArrayLike.html @@ -0,0 +1,3 @@ +AnyArrayLike | @salesforce/ts-types

    Type alias AnyArrayLike<T>

    AnyArrayLike<T>: ArrayLike<T>

    Any object with both a numeric index signature with values of type T and a numeric length +property. T defaults to unknown if unspecified.

    +

    Type Parameters

    • T = unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/AnyConstructor.html b/types/AnyConstructor.html index a6110c2a..1319207f 100644 --- a/types/AnyConstructor.html +++ b/types/AnyConstructor.html @@ -1,2 +1,2 @@ AnyConstructor | @salesforce/ts-types

    Type alias AnyConstructor<T>

    AnyConstructor<T>: (new (...args) => T)

    A constructor for any type T. T defaults to object when not explicitly supplied.

    -

    Type Parameters

    • T = object

    Type declaration

      • new (...args): T

      • Parameters

        • Rest ...args: any[]

        Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    • T = object

    Type declaration

      • new (...args): T

      • Parameters

        • Rest ...args: any[]

        Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/AnyFunction.html b/types/AnyFunction.html index c5b6ef2e..21401143 100644 --- a/types/AnyFunction.html +++ b/types/AnyFunction.html @@ -1,2 +1,2 @@ AnyFunction | @salesforce/ts-types

    Type alias AnyFunction<T>

    AnyFunction<T>: ((...args) => T)

    Any function returning type T. T defaults to unknown when not explicitly supplied.

    -

    Type Parameters

    • T = unknown

    Type declaration

      • (...args): T

      • Parameters

        • Rest ...args: any[]

        Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    • T = unknown

    Type declaration

      • (...args): T

      • Parameters

        • Rest ...args: any[]

        Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/AnyJson.html b/types/AnyJson.html index e467f17a..6f297a58 100644 --- a/types/AnyJson.html +++ b/types/AnyJson.html @@ -1,2 +1,2 @@ AnyJson | @salesforce/ts-types

    Type alias AnyJson

    AnyJson: JsonPrimitive | JsonCollection

    Any valid JSON value.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Dictionary.html b/types/Dictionary.html new file mode 100644 index 00000000..a384934a --- /dev/null +++ b/types/Dictionary.html @@ -0,0 +1,5 @@ +Dictionary | @salesforce/ts-types

    Type alias Dictionary<T>

    Dictionary<T>: {
        [key: string]: Optional<T>;
    }

    An object with arbitrary string-indexed values of an optional generic type Optional<T>. T defaults to unknown +when not explicitly supplied. For convenient iteration of definitely assigned (i.e. non-nullable) entries, keys, +and values, see the following functions: definiteEntriesOf, definiteKeysOf, and +definiteValuesOf.

    +

    Type Parameters

    • T = unknown

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/JsonArray.html b/types/JsonArray.html new file mode 100644 index 00000000..18b8a39d --- /dev/null +++ b/types/JsonArray.html @@ -0,0 +1,2 @@ +JsonArray | @salesforce/ts-types

    Type alias JsonArray

    JsonArray: AnyJson[]

    Any JSON-compatible array.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/JsonCollection.html b/types/JsonCollection.html index b5396803..4faf5375 100644 --- a/types/JsonCollection.html +++ b/types/JsonCollection.html @@ -1,2 +1,2 @@ -JsonCollection | @salesforce/ts-types

    Type alias JsonCollection

    JsonCollection: JsonMap | JsonArray

    Any valid JSON collection value.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +JsonCollection | @salesforce/ts-types

    Type alias JsonCollection

    JsonCollection: JsonMap | JsonArray

    Any valid JSON collection value.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/JsonPrimitive.html b/types/JsonPrimitive.html index 83f23475..e99508a9 100644 --- a/types/JsonPrimitive.html +++ b/types/JsonPrimitive.html @@ -1,2 +1,2 @@ JsonPrimitive | @salesforce/ts-types

    Type alias JsonPrimitive

    JsonPrimitive: null | boolean | number | string

    Any valid JSON primitive value.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/KeyOf.html b/types/KeyOf.html index 43978522..0b287aea 100644 --- a/types/KeyOf.html +++ b/types/KeyOf.html @@ -1,2 +1,2 @@ KeyOf | @salesforce/ts-types

    Type alias KeyOf<T>

    KeyOf<T>: Extract<keyof T, string>

    An alias for the commonly needed Extract<keyof T, string>.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/KeyValue.html b/types/KeyValue.html index 2132d568..b3670ce4 100644 --- a/types/KeyValue.html +++ b/types/KeyValue.html @@ -1,3 +1,3 @@ KeyValue | @salesforce/ts-types

    Type alias KeyValue<T>

    KeyValue<T>: [string, T]

    An alias for a tuple of type [string, T]' for a given generic type T. Tdefaults tounknown` if not otherwise defined.

    -

    Type Parameters

    • T = unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Literals.html b/types/Literals.html index 09120930..b3adda78 100644 --- a/types/Literals.html +++ b/types/Literals.html @@ -1,3 +1,3 @@ Literals | @salesforce/ts-types

    Type alias Literals<T>

    Literals<T>: Extract<{
            [K in keyof T]: string extends K
                ? never
                : number extends K
                    ? never
                    : K
        } extends {
            [_ in keyof T]: infer U
        }
        ? U
        : never, string>

    Extracts literally defined property names from a type T as a union of key name strings, minus any index signatures.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/LiteralsRecord.html b/types/LiteralsRecord.html index abade4c0..58fcc64b 100644 --- a/types/LiteralsRecord.html +++ b/types/LiteralsRecord.html @@ -5,4 +5,4 @@ generated type to the enum keys and remaining as DRY as possible.

    enum QUERY_KEY { id, name, created, updated }
    // type of QUERY_KEY -> {
    //     [x: number]: number;
    //     readonly id: number;
    //     readonly name: number;
    //     readonly created: number;
    //     readonly updated: number;
    // }
    interface QueryRecord extends LiteralsRecord<typeof QUERY_KEY, string> { }
    // type of QueryRecord -> {
    //     readonly id: string;
    //     readonly name: string;
    //     readonly created: string;
    //     readonly updated: string;
    // }
    // And for an interface with writable properties, use the following:
    interface QueryRecord extends ReadWrite<LiteralsRecord<typeof QUERY_KEY, string>> { }
    // type of QueryRecord -> {
    //     id: string;
    //     name: string;
    //     created: string;
    //     updated: string;
    // }
    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Many.html b/types/Many.html index 6ebe0963..2a928b40 100644 --- a/types/Many.html +++ b/types/Many.html @@ -1,2 +1,2 @@ Many | @salesforce/ts-types

    Type alias Many<T>

    Many<T>: T | T[]

    A union type for either the parameterized type T or an array of T.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/NonOptional.html b/types/NonOptional.html index 63410c93..f70e4b50 100644 --- a/types/NonOptional.html +++ b/types/NonOptional.html @@ -1,2 +1,2 @@ NonOptional | @salesforce/ts-types

    Type alias NonOptional<T>

    NonOptional<T>: T extends undefined
        ? never
        : T

    Subtracts undefined from any union type T. This is the opposite of Optional.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Nullable.html b/types/Nullable.html index 099124e2..2c42eac0 100644 --- a/types/Nullable.html +++ b/types/Nullable.html @@ -1,3 +1,3 @@ Nullable | @salesforce/ts-types

    Type alias Nullable<T>

    Nullable<T>: Optional<T | null>

    A union type for either the parameterized type T, null, or undefined -- the opposite of the NonNullable builtin conditional type.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Omit.html b/types/Omit.html index 5384ac1a..37b3583b 100644 --- a/types/Omit.html +++ b/types/Omit.html @@ -1,2 +1,2 @@ Omit | @salesforce/ts-types

    Type alias Omit<T, K>

    Omit<T, K>: Pick<T, Exclude<keyof T, K>>

    Creates a new type that omits keys in union type K of a target type T.

    -

    Type Parameters

    • T
    • K extends keyof T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Optional.html b/types/Optional.html index 136d0d87..43c99eca 100644 --- a/types/Optional.html +++ b/types/Optional.html @@ -1,2 +1,2 @@ Optional | @salesforce/ts-types

    Type alias Optional<T>

    Optional<T>: T | undefined

    A union type for either the parameterized type T or undefined -- the opposite of NonOptional.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Overwrite.html b/types/Overwrite.html index 96635191..96921d7a 100644 --- a/types/Overwrite.html +++ b/types/Overwrite.html @@ -4,4 +4,4 @@ change their type or to make them optional.

    type NameAndStringValue = { name: string, value: string }
    type NameAndOptionalNumericValue = Overwrite<NameAndValue, { value?: number }>
    // type of NameAndOptionalNumericValue -> { name: string } & { value?: number | undefined }
    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ReadWrite.html b/types/ReadWrite.html index f29b9fee..a22f77f0 100644 --- a/types/ReadWrite.html +++ b/types/ReadWrite.html @@ -1,3 +1,3 @@ ReadWrite | @salesforce/ts-types

    Type alias ReadWrite<T>

    ReadWrite<T>: {
        -readonly [K in keyof T]: T[K]
    }

    Converts readonly properties of a type T to writable properties. This is the opposite of the Readonly<T> builtin mapped type.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/RequiredNonNullable.html b/types/RequiredNonNullable.html index 54b210ad..23f40beb 100644 --- a/types/RequiredNonNullable.html +++ b/types/RequiredNonNullable.html @@ -2,4 +2,4 @@ properties, while also subtracting null from all possible property values.

    type Foo = { bar?: string | undefined | null };
    type RequiredNonNullableFoo = RequiredNonNullable<Foo>;
    // RequiredNonNullableFoo -> { bar: string };
    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/RequiredNonOptional.html b/types/RequiredNonOptional.html index 5ddd8b9c..f580aadb 100644 --- a/types/RequiredNonOptional.html +++ b/types/RequiredNonOptional.html @@ -4,4 +4,4 @@ subtracts undefined from value union types as well as the optional property declaration.

    type Foo = { bar?: string | undefined | null };
    type RequiredNonOptionalFoo = RequiredNonOptional<Foo>;
    // RequiredNonOptionalFoo -> { bar: string | null };
    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/View.html b/types/View.html index ef47fca8..aa0fe96c 100644 --- a/types/View.html +++ b/types/View.html @@ -1,2 +1,2 @@ View | @salesforce/ts-types

    Type alias View<K, V>

    View<K, V>: {
        [_ in K]: V
    }

    A view over an object with constrainable properties.

    -

    Type Parameters

    • K extends string
    • V = unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file