From 15d34dd8a4e3285c0d8fa2175a0b5dd76fd89733 Mon Sep 17 00:00:00 2001 From: Benny Neugebauer Date: Tue, 21 Nov 2023 16:19:30 +0100 Subject: [PATCH] chore: Generated release files --- CHANGELOG.md | 259 ++++-- docs/assets/highlight.css | 73 +- docs/assets/main.js | 1807 ++++++++++++++++++++++++++++++++++++- docs/assets/navigation.js | 3 +- docs/assets/search.js | 3 +- docs/assets/style.css | 1574 ++++++++++++++++---------------- docs/classes/MyClass.html | 966 +++++++++++++++++++- docs/index.html | 1203 ++++++++++++++++++++++-- docs/modules.html | 766 +++++++++++++++- 9 files changed, 5657 insertions(+), 997 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2415f324..c109b65a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,133 +2,202 @@ ##### Documentation Changes -* Generated public docs ([331ee28b](https://github.com/bennycode/ts-node-starter/commit/331ee28bfc48c8d5749ecff334ac6dedb19cf7de)) -* updated CHANGELOG.md ([377f7e81](https://github.com/bennycode/ts-node-starter/commit/377f7e812e6c2b6db6520cc4e5c3f170712ff6c4)) -* Use Vitest Globals ([cfb8e764](https://github.com/bennycode/ts-node-starter/commit/cfb8e76453baa81bffbd602bb570f16b8699657b)) -* Switch to EcmaScript Modules (ESM) ([3c6c51e4](https://github.com/bennycode/ts-node-starter/commit/3c6c51e4ee70fd44e3723f04eb7f1dc115261310)) -* Replaced Jest with Vitest ([46cd7423](https://github.com/bennycode/ts-node-starter/commit/46cd74238a84e6618b70a312c60d6ad03e98220b)) -* Replaced pretty-quick with Prettier 3 ([84267658](https://github.com/bennycode/ts-node-starter/commit/842676587b6a5f0347ac521db1022763b0905e1e)) -* Replace yarn with npm ([16dd53e6](https://github.com/bennycode/ts-node-starter/commit/16dd53e6d325c9eb4003b0b0fc440440941f7617)) -* Use direct Jest global APIs ([23206dae](https://github.com/bennycode/ts-node-starter/commit/23206daef8b23947440c1d58ba6cb1e661d78404)) -* List Shareable Config ([032bed00](https://github.com/bennycode/ts-node-starter/commit/032bed00fe630b55f485b7e223e8d94eae83bac4)) -* List important refactorings ([b227dafb](https://github.com/bennycode/ts-node-starter/commit/b227dafbfe6b7988465c2ec3ebb1ee4289a3a839)) -* Mention project name ([39ea6c3a](https://github.com/bennycode/ts-node-starter/commit/39ea6c3a05a87acf1065143ed942d9ac6dabd590)) -* Replace project name ([352ffd21](https://github.com/bennycode/ts-node-starter/commit/352ffd2169ef1040a4fa750d55f8a1af86fbd695)) -* Describe template repository ([1cc0516f](https://github.com/bennycode/ts-node-starter/commit/1cc0516f6bccf7ea7d91a8c5174bbae55a6e2c27)) +- Generated public docs ([1f2b6c1f](https://github.com/bennycode/ts-node-starter/commit/1f2b6c1f8b2559c0a33c9e62f6d600bac57359a1)) +- updated CHANGELOG.md ([6f74ca97](https://github.com/bennycode/ts-node-starter/commit/6f74ca97631cead4414ea4a4ad4bcc3c1f2b13dd)) +- Generated public docs ([331ee28b](https://github.com/bennycode/ts-node-starter/commit/331ee28bfc48c8d5749ecff334ac6dedb19cf7de)) +- updated CHANGELOG.md ([377f7e81](https://github.com/bennycode/ts-node-starter/commit/377f7e812e6c2b6db6520cc4e5c3f170712ff6c4)) +- Use Vitest Globals ([cfb8e764](https://github.com/bennycode/ts-node-starter/commit/cfb8e76453baa81bffbd602bb570f16b8699657b)) +- Switch to EcmaScript Modules (ESM) ([3c6c51e4](https://github.com/bennycode/ts-node-starter/commit/3c6c51e4ee70fd44e3723f04eb7f1dc115261310)) +- Replaced Jest with Vitest ([46cd7423](https://github.com/bennycode/ts-node-starter/commit/46cd74238a84e6618b70a312c60d6ad03e98220b)) +- Replaced pretty-quick with Prettier 3 ([84267658](https://github.com/bennycode/ts-node-starter/commit/842676587b6a5f0347ac521db1022763b0905e1e)) +- Replace yarn with npm ([16dd53e6](https://github.com/bennycode/ts-node-starter/commit/16dd53e6d325c9eb4003b0b0fc440440941f7617)) +- Use direct Jest global APIs ([23206dae](https://github.com/bennycode/ts-node-starter/commit/23206daef8b23947440c1d58ba6cb1e661d78404)) +- List Shareable Config ([032bed00](https://github.com/bennycode/ts-node-starter/commit/032bed00fe630b55f485b7e223e8d94eae83bac4)) +- List important refactorings ([b227dafb](https://github.com/bennycode/ts-node-starter/commit/b227dafbfe6b7988465c2ec3ebb1ee4289a3a839)) +- Mention project name ([39ea6c3a](https://github.com/bennycode/ts-node-starter/commit/39ea6c3a05a87acf1065143ed942d9ac6dabd590)) +- Replace project name ([352ffd21](https://github.com/bennycode/ts-node-starter/commit/352ffd2169ef1040a4fa750d55f8a1af86fbd695)) +- Describe template repository ([1cc0516f](https://github.com/bennycode/ts-node-starter/commit/1cc0516f6bccf7ea7d91a8c5174bbae55a6e2c27)) ##### New Features -* Add docs generation ([4fbfe0f1](https://github.com/bennycode/ts-node-starter/commit/4fbfe0f170748f2368a01f8b7a94984661c88a96)) -* Reuse testing workflow ([#594](https://github.com/bennycode/ts-node-starter/pull/594)) ([00541e7f](https://github.com/bennycode/ts-node-starter/commit/00541e7f9752b99ac79011eda1fe9f50d9aca553)) -* Cancel concurrent tests ([f5a1a96a](https://github.com/bennycode/ts-node-starter/commit/f5a1a96a2472955fb995e00923e72f0eaf328616)) -* Control import statements which should be emitted into JavaScript ([767c5eb2](https://github.com/bennycode/ts-node-starter/commit/767c5eb290ec674092ca74f85467e90c4f844364)) -* Add Node.js inspector for debugging purposes ([7b36600d](https://github.com/bennycode/ts-node-starter/commit/7b36600de4e6a764e66c5d18f59232fa2faea17c)) -* Add CLI demo ([788751b4](https://github.com/bennycode/ts-node-starter/commit/788751b4ef9dbd8bcf3aca65cef76a0d8114784e)) -* Define end of line setting ([23334cef](https://github.com/bennycode/ts-node-starter/commit/23334cef695752289c2a79fac695fb4ebc6ac0f3)) -* Use auto-merge functionality ([896a2a4b](https://github.com/bennycode/ts-node-starter/commit/896a2a4bd33c76768d984efad1e2b0e33bc7ea61)) -* Automatically update GitHub Actions ([51c54dae](https://github.com/bennycode/ts-node-starter/commit/51c54dae68b416d8edc53a66381ef551a7c7c0d9)) -* Log explicit Prettier errors to console ([7d7e6388](https://github.com/bennycode/ts-node-starter/commit/7d7e63888b24592fded5226ad377cbd3deaba5c9)) -* Create releases through GitHub ([e873290c](https://github.com/bennycode/ts-node-starter/commit/e873290cda30e9c508070e497031b6f2a8c5ca61)) -* **ci:** Reduce amount of builds ([d612d21f](https://github.com/bennycode/ts-node-starter/commit/d612d21f83d5f59207c0192610df5e6ca55bcf02)) -* **test:** Pass test script without tests ([d40edc9a](https://github.com/bennycode/ts-node-starter/commit/d40edc9a9557ecfa42991c6bf5976141bf48d088)) +- Add docs generation ([4fbfe0f1](https://github.com/bennycode/ts-node-starter/commit/4fbfe0f170748f2368a01f8b7a94984661c88a96)) +- Reuse testing workflow ([#594](https://github.com/bennycode/ts-node-starter/pull/594)) ([00541e7f](https://github.com/bennycode/ts-node-starter/commit/00541e7f9752b99ac79011eda1fe9f50d9aca553)) +- Cancel concurrent tests ([f5a1a96a](https://github.com/bennycode/ts-node-starter/commit/f5a1a96a2472955fb995e00923e72f0eaf328616)) +- Control import statements which should be emitted into JavaScript ([767c5eb2](https://github.com/bennycode/ts-node-starter/commit/767c5eb290ec674092ca74f85467e90c4f844364)) +- Add Node.js inspector for debugging purposes ([7b36600d](https://github.com/bennycode/ts-node-starter/commit/7b36600de4e6a764e66c5d18f59232fa2faea17c)) +- Add CLI demo ([788751b4](https://github.com/bennycode/ts-node-starter/commit/788751b4ef9dbd8bcf3aca65cef76a0d8114784e)) +- Define end of line setting ([23334cef](https://github.com/bennycode/ts-node-starter/commit/23334cef695752289c2a79fac695fb4ebc6ac0f3)) +- Use auto-merge functionality ([896a2a4b](https://github.com/bennycode/ts-node-starter/commit/896a2a4bd33c76768d984efad1e2b0e33bc7ea61)) +- Automatically update GitHub Actions ([51c54dae](https://github.com/bennycode/ts-node-starter/commit/51c54dae68b416d8edc53a66381ef551a7c7c0d9)) +- Log explicit Prettier errors to console ([7d7e6388](https://github.com/bennycode/ts-node-starter/commit/7d7e63888b24592fded5226ad377cbd3deaba5c9)) +- Create releases through GitHub ([e873290c](https://github.com/bennycode/ts-node-starter/commit/e873290cda30e9c508070e497031b6f2a8c5ca61)) +- **ci:** Reduce amount of builds ([d612d21f](https://github.com/bennycode/ts-node-starter/commit/d612d21f83d5f59207c0192610df5e6ca55bcf02)) +- **test:** Pass test script without tests ([d40edc9a](https://github.com/bennycode/ts-node-starter/commit/d40edc9a9557ecfa42991c6bf5976141bf48d088)) ##### Bug Fixes -* Don't publish vitest config ([e44ad4c3](https://github.com/bennycode/ts-node-starter/commit/e44ad4c3b51a11c6a20a0b43abaa098f391ff067)) -* update link to CLI script ([cb492b6f](https://github.com/bennycode/ts-node-starter/commit/cb492b6fdde2f7f8ea62b74fb5be51933f9d6c23)) -* use npm install ([6f6fe9f3](https://github.com/bennycode/ts-node-starter/commit/6f6fe9f376c8830d450ed7758947a657bbe9ec22)) -* Use ts-node-esm for ES modules ([39cda170](https://github.com/bennycode/ts-node-starter/commit/39cda170d12fae2ff4b6122df2f85f04613ee99b)) -* Update deprecated Prettier option ([b83164f1](https://github.com/bennycode/ts-node-starter/commit/b83164f1dc1dfb395d452343b34b3739c6d268df)) -* forward fix command options ([2da0f1bf](https://github.com/bennycode/ts-node-starter/commit/2da0f1bfe160c1bc3a74341a24c8b0681dcdcb40)) -* Remove postinstall script to work as library ([64adc38d](https://github.com/bennycode/ts-node-starter/commit/64adc38ded8cddd78e5ebde42cc25bb53eb1c73e)) +- Don't publish vitest config ([e44ad4c3](https://github.com/bennycode/ts-node-starter/commit/e44ad4c3b51a11c6a20a0b43abaa098f391ff067)) +- update link to CLI script ([cb492b6f](https://github.com/bennycode/ts-node-starter/commit/cb492b6fdde2f7f8ea62b74fb5be51933f9d6c23)) +- use npm install ([6f6fe9f3](https://github.com/bennycode/ts-node-starter/commit/6f6fe9f376c8830d450ed7758947a657bbe9ec22)) +- Use ts-node-esm for ES modules ([39cda170](https://github.com/bennycode/ts-node-starter/commit/39cda170d12fae2ff4b6122df2f85f04613ee99b)) +- Update deprecated Prettier option ([b83164f1](https://github.com/bennycode/ts-node-starter/commit/b83164f1dc1dfb395d452343b34b3739c6d268df)) +- forward fix command options ([2da0f1bf](https://github.com/bennycode/ts-node-starter/commit/2da0f1bfe160c1bc3a74341a24c8b0681dcdcb40)) +- Remove postinstall script to work as library ([64adc38d](https://github.com/bennycode/ts-node-starter/commit/64adc38ded8cddd78e5ebde42cc25bb53eb1c73e)) ##### Other Changes -* Switch to EcmaScript modules (ESM) ([#603](https://github.com/bennycode/ts-node-starter/pull/603)) ([0cae631c](https://github.com/bennycode/ts-node-starter/commit/0cae631ca6457026919418ddb3a10f7858e9ad55)) +- Switch to EcmaScript modules (ESM) ([#603](https://github.com/bennycode/ts-node-starter/pull/603)) ([0cae631c](https://github.com/bennycode/ts-node-starter/commit/0cae631ca6457026919418ddb3a10f7858e9ad55)) ##### Refactors -* Use Vitest globals ([#622](https://github.com/bennycode/ts-node-starter/pull/622)) ([6b273c3c](https://github.com/bennycode/ts-node-starter/commit/6b273c3c09552d5aa829f48987c1c1dcf7a93ce9)) -* Replaced Jest with Vitest ([#602](https://github.com/bennycode/ts-node-starter/pull/602)) ([662dddf9](https://github.com/bennycode/ts-node-starter/commit/662dddf92d418d0e1119a04d8f5fe807a7a566f0)) -* Replace pretty-quick with Prettier 3.0 ([#601](https://github.com/bennycode/ts-node-starter/pull/601)) ([7623ba89](https://github.com/bennycode/ts-node-starter/commit/7623ba894e6767d7da8ce5b8a1e2469639bcb027)) -* Follow Conventional Scripts ([#591](https://github.com/bennycode/ts-node-starter/pull/591)) ([6b3bd190](https://github.com/bennycode/ts-node-starter/commit/6b3bd1907272b4dbcd98d04a20c3052652093069)) -* Replace yarn with npm ([153b7267](https://github.com/bennycode/ts-node-starter/commit/153b726761db302fa3ba57ed1d71aabae01d8394)) -* Replace @types/jest with @jest/globals ([73c5bc24](https://github.com/bennycode/ts-node-starter/commit/73c5bc246de79ca2cc805a8b61e42bec39cb97fd)) -* Remove lint-staged ([dbafb517](https://github.com/bennycode/ts-node-starter/commit/dbafb51742a18311d32a9295ea1df5dffbea86bd)) -* Replace husky with Lefthook ([#518](https://github.com/bennycode/ts-node-starter/pull/518)) ([9c416150](https://github.com/bennycode/ts-node-starter/commit/9c4161509acf49e56042383c9ea340f68f248582)) -* Replace EditorConfig with Prettier ([2e24f7be](https://github.com/bennycode/ts-node-starter/commit/2e24f7be5f427c26d6cc8281438a6398a211b75c)) -* Replace action-dependabot-auto-merge ([86d56961](https://github.com/bennycode/ts-node-starter/commit/86d5696113c2fb4907a1666e25d1b72d698b06a5)) -* Encapsulate dependency names ([8a9e0c43](https://github.com/bennycode/ts-node-starter/commit/8a9e0c432d9665ce57e282a0b9d57d418114b060)) -* **config:** Use ESLint config from @typescripttv ([eef59275](https://github.com/bennycode/ts-node-starter/commit/eef59275e91f6f484f7a917fdd87b09318ebbad3)) -* **test:** Replace Jasmine with Jest ([#405](https://github.com/bennycode/ts-node-starter/pull/405)) ([41e9b42b](https://github.com/bennycode/ts-node-starter/commit/41e9b42bb5b7ca364dbbabf1104955090003d1be)) +- Use Vitest globals ([#622](https://github.com/bennycode/ts-node-starter/pull/622)) ([6b273c3c](https://github.com/bennycode/ts-node-starter/commit/6b273c3c09552d5aa829f48987c1c1dcf7a93ce9)) +- Replaced Jest with Vitest ([#602](https://github.com/bennycode/ts-node-starter/pull/602)) ([662dddf9](https://github.com/bennycode/ts-node-starter/commit/662dddf92d418d0e1119a04d8f5fe807a7a566f0)) +- Replace pretty-quick with Prettier 3.0 ([#601](https://github.com/bennycode/ts-node-starter/pull/601)) ([7623ba89](https://github.com/bennycode/ts-node-starter/commit/7623ba894e6767d7da8ce5b8a1e2469639bcb027)) +- Follow Conventional Scripts ([#591](https://github.com/bennycode/ts-node-starter/pull/591)) ([6b3bd190](https://github.com/bennycode/ts-node-starter/commit/6b3bd1907272b4dbcd98d04a20c3052652093069)) +- Replace yarn with npm ([153b7267](https://github.com/bennycode/ts-node-starter/commit/153b726761db302fa3ba57ed1d71aabae01d8394)) +- Replace @types/jest with @jest/globals ([73c5bc24](https://github.com/bennycode/ts-node-starter/commit/73c5bc246de79ca2cc805a8b61e42bec39cb97fd)) +- Remove lint-staged ([dbafb517](https://github.com/bennycode/ts-node-starter/commit/dbafb51742a18311d32a9295ea1df5dffbea86bd)) +- Replace husky with Lefthook ([#518](https://github.com/bennycode/ts-node-starter/pull/518)) ([9c416150](https://github.com/bennycode/ts-node-starter/commit/9c4161509acf49e56042383c9ea340f68f248582)) +- Replace EditorConfig with Prettier ([2e24f7be](https://github.com/bennycode/ts-node-starter/commit/2e24f7be5f427c26d6cc8281438a6398a211b75c)) +- Replace action-dependabot-auto-merge ([86d56961](https://github.com/bennycode/ts-node-starter/commit/86d5696113c2fb4907a1666e25d1b72d698b06a5)) +- Encapsulate dependency names ([8a9e0c43](https://github.com/bennycode/ts-node-starter/commit/8a9e0c432d9665ce57e282a0b9d57d418114b060)) +- **config:** Use ESLint config from @typescripttv ([eef59275](https://github.com/bennycode/ts-node-starter/commit/eef59275e91f6f484f7a917fdd87b09318ebbad3)) +- **test:** Replace Jasmine with Jest ([#405](https://github.com/bennycode/ts-node-starter/pull/405)) ([41e9b42b](https://github.com/bennycode/ts-node-starter/commit/41e9b42bb5b7ca364dbbabf1104955090003d1be)) ##### Code Style Changes -* Enforce single attribute per line in HTML ([828c8eba](https://github.com/bennycode/ts-node-starter/commit/828c8ebae47886aebb0ef536540eb57547574628)) +- Enforce single attribute per line in HTML ([828c8eba](https://github.com/bennycode/ts-node-starter/commit/828c8ebae47886aebb0ef536540eb57547574628)) -## 1.0.0 (2023-11-21) +### 0.1.0 (2023-11-21) ##### Documentation Changes -* Use Vitest Globals ([cfb8e764](https://github.com/bennycode/ts-node-starter/commit/cfb8e76453baa81bffbd602bb570f16b8699657b)) -* Switch to EcmaScript Modules (ESM) ([3c6c51e4](https://github.com/bennycode/ts-node-starter/commit/3c6c51e4ee70fd44e3723f04eb7f1dc115261310)) -* Replaced Jest with Vitest ([46cd7423](https://github.com/bennycode/ts-node-starter/commit/46cd74238a84e6618b70a312c60d6ad03e98220b)) -* Replaced pretty-quick with Prettier 3 ([84267658](https://github.com/bennycode/ts-node-starter/commit/842676587b6a5f0347ac521db1022763b0905e1e)) -* Replace yarn with npm ([16dd53e6](https://github.com/bennycode/ts-node-starter/commit/16dd53e6d325c9eb4003b0b0fc440440941f7617)) -* Use direct Jest global APIs ([23206dae](https://github.com/bennycode/ts-node-starter/commit/23206daef8b23947440c1d58ba6cb1e661d78404)) -* List Shareable Config ([032bed00](https://github.com/bennycode/ts-node-starter/commit/032bed00fe630b55f485b7e223e8d94eae83bac4)) -* List important refactorings ([b227dafb](https://github.com/bennycode/ts-node-starter/commit/b227dafbfe6b7988465c2ec3ebb1ee4289a3a839)) -* Mention project name ([39ea6c3a](https://github.com/bennycode/ts-node-starter/commit/39ea6c3a05a87acf1065143ed942d9ac6dabd590)) -* Replace project name ([352ffd21](https://github.com/bennycode/ts-node-starter/commit/352ffd2169ef1040a4fa750d55f8a1af86fbd695)) -* Describe template repository ([1cc0516f](https://github.com/bennycode/ts-node-starter/commit/1cc0516f6bccf7ea7d91a8c5174bbae55a6e2c27)) +- Generated public docs ([331ee28b](https://github.com/bennycode/ts-node-starter/commit/331ee28bfc48c8d5749ecff334ac6dedb19cf7de)) +- updated CHANGELOG.md ([377f7e81](https://github.com/bennycode/ts-node-starter/commit/377f7e812e6c2b6db6520cc4e5c3f170712ff6c4)) +- Use Vitest Globals ([cfb8e764](https://github.com/bennycode/ts-node-starter/commit/cfb8e76453baa81bffbd602bb570f16b8699657b)) +- Switch to EcmaScript Modules (ESM) ([3c6c51e4](https://github.com/bennycode/ts-node-starter/commit/3c6c51e4ee70fd44e3723f04eb7f1dc115261310)) +- Replaced Jest with Vitest ([46cd7423](https://github.com/bennycode/ts-node-starter/commit/46cd74238a84e6618b70a312c60d6ad03e98220b)) +- Replaced pretty-quick with Prettier 3 ([84267658](https://github.com/bennycode/ts-node-starter/commit/842676587b6a5f0347ac521db1022763b0905e1e)) +- Replace yarn with npm ([16dd53e6](https://github.com/bennycode/ts-node-starter/commit/16dd53e6d325c9eb4003b0b0fc440440941f7617)) +- Use direct Jest global APIs ([23206dae](https://github.com/bennycode/ts-node-starter/commit/23206daef8b23947440c1d58ba6cb1e661d78404)) +- List Shareable Config ([032bed00](https://github.com/bennycode/ts-node-starter/commit/032bed00fe630b55f485b7e223e8d94eae83bac4)) +- List important refactorings ([b227dafb](https://github.com/bennycode/ts-node-starter/commit/b227dafbfe6b7988465c2ec3ebb1ee4289a3a839)) +- Mention project name ([39ea6c3a](https://github.com/bennycode/ts-node-starter/commit/39ea6c3a05a87acf1065143ed942d9ac6dabd590)) +- Replace project name ([352ffd21](https://github.com/bennycode/ts-node-starter/commit/352ffd2169ef1040a4fa750d55f8a1af86fbd695)) +- Describe template repository ([1cc0516f](https://github.com/bennycode/ts-node-starter/commit/1cc0516f6bccf7ea7d91a8c5174bbae55a6e2c27)) ##### New Features -* Add docs generation ([4fbfe0f1](https://github.com/bennycode/ts-node-starter/commit/4fbfe0f170748f2368a01f8b7a94984661c88a96)) -* Reuse testing workflow ([#594](https://github.com/bennycode/ts-node-starter/pull/594)) ([00541e7f](https://github.com/bennycode/ts-node-starter/commit/00541e7f9752b99ac79011eda1fe9f50d9aca553)) -* Cancel concurrent tests ([f5a1a96a](https://github.com/bennycode/ts-node-starter/commit/f5a1a96a2472955fb995e00923e72f0eaf328616)) -* Control import statements which should be emitted into JavaScript ([767c5eb2](https://github.com/bennycode/ts-node-starter/commit/767c5eb290ec674092ca74f85467e90c4f844364)) -* Add Node.js inspector for debugging purposes ([7b36600d](https://github.com/bennycode/ts-node-starter/commit/7b36600de4e6a764e66c5d18f59232fa2faea17c)) -* Add CLI demo ([788751b4](https://github.com/bennycode/ts-node-starter/commit/788751b4ef9dbd8bcf3aca65cef76a0d8114784e)) -* Define end of line setting ([23334cef](https://github.com/bennycode/ts-node-starter/commit/23334cef695752289c2a79fac695fb4ebc6ac0f3)) -* Use auto-merge functionality ([896a2a4b](https://github.com/bennycode/ts-node-starter/commit/896a2a4bd33c76768d984efad1e2b0e33bc7ea61)) -* Automatically update GitHub Actions ([51c54dae](https://github.com/bennycode/ts-node-starter/commit/51c54dae68b416d8edc53a66381ef551a7c7c0d9)) -* Log explicit Prettier errors to console ([7d7e6388](https://github.com/bennycode/ts-node-starter/commit/7d7e63888b24592fded5226ad377cbd3deaba5c9)) -* Create releases through GitHub ([e873290c](https://github.com/bennycode/ts-node-starter/commit/e873290cda30e9c508070e497031b6f2a8c5ca61)) -* **ci:** Reduce amount of builds ([d612d21f](https://github.com/bennycode/ts-node-starter/commit/d612d21f83d5f59207c0192610df5e6ca55bcf02)) -* **test:** Pass test script without tests ([d40edc9a](https://github.com/bennycode/ts-node-starter/commit/d40edc9a9557ecfa42991c6bf5976141bf48d088)) +- Add docs generation ([4fbfe0f1](https://github.com/bennycode/ts-node-starter/commit/4fbfe0f170748f2368a01f8b7a94984661c88a96)) +- Reuse testing workflow ([#594](https://github.com/bennycode/ts-node-starter/pull/594)) ([00541e7f](https://github.com/bennycode/ts-node-starter/commit/00541e7f9752b99ac79011eda1fe9f50d9aca553)) +- Cancel concurrent tests ([f5a1a96a](https://github.com/bennycode/ts-node-starter/commit/f5a1a96a2472955fb995e00923e72f0eaf328616)) +- Control import statements which should be emitted into JavaScript ([767c5eb2](https://github.com/bennycode/ts-node-starter/commit/767c5eb290ec674092ca74f85467e90c4f844364)) +- Add Node.js inspector for debugging purposes ([7b36600d](https://github.com/bennycode/ts-node-starter/commit/7b36600de4e6a764e66c5d18f59232fa2faea17c)) +- Add CLI demo ([788751b4](https://github.com/bennycode/ts-node-starter/commit/788751b4ef9dbd8bcf3aca65cef76a0d8114784e)) +- Define end of line setting ([23334cef](https://github.com/bennycode/ts-node-starter/commit/23334cef695752289c2a79fac695fb4ebc6ac0f3)) +- Use auto-merge functionality ([896a2a4b](https://github.com/bennycode/ts-node-starter/commit/896a2a4bd33c76768d984efad1e2b0e33bc7ea61)) +- Automatically update GitHub Actions ([51c54dae](https://github.com/bennycode/ts-node-starter/commit/51c54dae68b416d8edc53a66381ef551a7c7c0d9)) +- Log explicit Prettier errors to console ([7d7e6388](https://github.com/bennycode/ts-node-starter/commit/7d7e63888b24592fded5226ad377cbd3deaba5c9)) +- Create releases through GitHub ([e873290c](https://github.com/bennycode/ts-node-starter/commit/e873290cda30e9c508070e497031b6f2a8c5ca61)) +- **ci:** Reduce amount of builds ([d612d21f](https://github.com/bennycode/ts-node-starter/commit/d612d21f83d5f59207c0192610df5e6ca55bcf02)) +- **test:** Pass test script without tests ([d40edc9a](https://github.com/bennycode/ts-node-starter/commit/d40edc9a9557ecfa42991c6bf5976141bf48d088)) ##### Bug Fixes -* Don't publish vitest config ([e44ad4c3](https://github.com/bennycode/ts-node-starter/commit/e44ad4c3b51a11c6a20a0b43abaa098f391ff067)) -* update link to CLI script ([cb492b6f](https://github.com/bennycode/ts-node-starter/commit/cb492b6fdde2f7f8ea62b74fb5be51933f9d6c23)) -* use npm install ([6f6fe9f3](https://github.com/bennycode/ts-node-starter/commit/6f6fe9f376c8830d450ed7758947a657bbe9ec22)) -* Use ts-node-esm for ES modules ([39cda170](https://github.com/bennycode/ts-node-starter/commit/39cda170d12fae2ff4b6122df2f85f04613ee99b)) -* Update deprecated Prettier option ([b83164f1](https://github.com/bennycode/ts-node-starter/commit/b83164f1dc1dfb395d452343b34b3739c6d268df)) -* forward fix command options ([2da0f1bf](https://github.com/bennycode/ts-node-starter/commit/2da0f1bfe160c1bc3a74341a24c8b0681dcdcb40)) -* Remove postinstall script to work as library ([64adc38d](https://github.com/bennycode/ts-node-starter/commit/64adc38ded8cddd78e5ebde42cc25bb53eb1c73e)) +- Don't publish vitest config ([e44ad4c3](https://github.com/bennycode/ts-node-starter/commit/e44ad4c3b51a11c6a20a0b43abaa098f391ff067)) +- update link to CLI script ([cb492b6f](https://github.com/bennycode/ts-node-starter/commit/cb492b6fdde2f7f8ea62b74fb5be51933f9d6c23)) +- use npm install ([6f6fe9f3](https://github.com/bennycode/ts-node-starter/commit/6f6fe9f376c8830d450ed7758947a657bbe9ec22)) +- Use ts-node-esm for ES modules ([39cda170](https://github.com/bennycode/ts-node-starter/commit/39cda170d12fae2ff4b6122df2f85f04613ee99b)) +- Update deprecated Prettier option ([b83164f1](https://github.com/bennycode/ts-node-starter/commit/b83164f1dc1dfb395d452343b34b3739c6d268df)) +- forward fix command options ([2da0f1bf](https://github.com/bennycode/ts-node-starter/commit/2da0f1bfe160c1bc3a74341a24c8b0681dcdcb40)) +- Remove postinstall script to work as library ([64adc38d](https://github.com/bennycode/ts-node-starter/commit/64adc38ded8cddd78e5ebde42cc25bb53eb1c73e)) ##### Other Changes -* Switch to EcmaScript modules (ESM) ([#603](https://github.com/bennycode/ts-node-starter/pull/603)) ([0cae631c](https://github.com/bennycode/ts-node-starter/commit/0cae631ca6457026919418ddb3a10f7858e9ad55)) +- Switch to EcmaScript modules (ESM) ([#603](https://github.com/bennycode/ts-node-starter/pull/603)) ([0cae631c](https://github.com/bennycode/ts-node-starter/commit/0cae631ca6457026919418ddb3a10f7858e9ad55)) ##### Refactors -* Use Vitest globals ([#622](https://github.com/bennycode/ts-node-starter/pull/622)) ([6b273c3c](https://github.com/bennycode/ts-node-starter/commit/6b273c3c09552d5aa829f48987c1c1dcf7a93ce9)) -* Replaced Jest with Vitest ([#602](https://github.com/bennycode/ts-node-starter/pull/602)) ([662dddf9](https://github.com/bennycode/ts-node-starter/commit/662dddf92d418d0e1119a04d8f5fe807a7a566f0)) -* Replace pretty-quick with Prettier 3.0 ([#601](https://github.com/bennycode/ts-node-starter/pull/601)) ([7623ba89](https://github.com/bennycode/ts-node-starter/commit/7623ba894e6767d7da8ce5b8a1e2469639bcb027)) -* Follow Conventional Scripts ([#591](https://github.com/bennycode/ts-node-starter/pull/591)) ([6b3bd190](https://github.com/bennycode/ts-node-starter/commit/6b3bd1907272b4dbcd98d04a20c3052652093069)) -* Replace yarn with npm ([153b7267](https://github.com/bennycode/ts-node-starter/commit/153b726761db302fa3ba57ed1d71aabae01d8394)) -* Replace @types/jest with @jest/globals ([73c5bc24](https://github.com/bennycode/ts-node-starter/commit/73c5bc246de79ca2cc805a8b61e42bec39cb97fd)) -* Remove lint-staged ([dbafb517](https://github.com/bennycode/ts-node-starter/commit/dbafb51742a18311d32a9295ea1df5dffbea86bd)) -* Replace husky with Lefthook ([#518](https://github.com/bennycode/ts-node-starter/pull/518)) ([9c416150](https://github.com/bennycode/ts-node-starter/commit/9c4161509acf49e56042383c9ea340f68f248582)) -* Replace EditorConfig with Prettier ([2e24f7be](https://github.com/bennycode/ts-node-starter/commit/2e24f7be5f427c26d6cc8281438a6398a211b75c)) -* Replace action-dependabot-auto-merge ([86d56961](https://github.com/bennycode/ts-node-starter/commit/86d5696113c2fb4907a1666e25d1b72d698b06a5)) -* Encapsulate dependency names ([8a9e0c43](https://github.com/bennycode/ts-node-starter/commit/8a9e0c432d9665ce57e282a0b9d57d418114b060)) -* **config:** Use ESLint config from @typescripttv ([eef59275](https://github.com/bennycode/ts-node-starter/commit/eef59275e91f6f484f7a917fdd87b09318ebbad3)) -* **test:** Replace Jasmine with Jest ([#405](https://github.com/bennycode/ts-node-starter/pull/405)) ([41e9b42b](https://github.com/bennycode/ts-node-starter/commit/41e9b42bb5b7ca364dbbabf1104955090003d1be)) +- Use Vitest globals ([#622](https://github.com/bennycode/ts-node-starter/pull/622)) ([6b273c3c](https://github.com/bennycode/ts-node-starter/commit/6b273c3c09552d5aa829f48987c1c1dcf7a93ce9)) +- Replaced Jest with Vitest ([#602](https://github.com/bennycode/ts-node-starter/pull/602)) ([662dddf9](https://github.com/bennycode/ts-node-starter/commit/662dddf92d418d0e1119a04d8f5fe807a7a566f0)) +- Replace pretty-quick with Prettier 3.0 ([#601](https://github.com/bennycode/ts-node-starter/pull/601)) ([7623ba89](https://github.com/bennycode/ts-node-starter/commit/7623ba894e6767d7da8ce5b8a1e2469639bcb027)) +- Follow Conventional Scripts ([#591](https://github.com/bennycode/ts-node-starter/pull/591)) ([6b3bd190](https://github.com/bennycode/ts-node-starter/commit/6b3bd1907272b4dbcd98d04a20c3052652093069)) +- Replace yarn with npm ([153b7267](https://github.com/bennycode/ts-node-starter/commit/153b726761db302fa3ba57ed1d71aabae01d8394)) +- Replace @types/jest with @jest/globals ([73c5bc24](https://github.com/bennycode/ts-node-starter/commit/73c5bc246de79ca2cc805a8b61e42bec39cb97fd)) +- Remove lint-staged ([dbafb517](https://github.com/bennycode/ts-node-starter/commit/dbafb51742a18311d32a9295ea1df5dffbea86bd)) +- Replace husky with Lefthook ([#518](https://github.com/bennycode/ts-node-starter/pull/518)) ([9c416150](https://github.com/bennycode/ts-node-starter/commit/9c4161509acf49e56042383c9ea340f68f248582)) +- Replace EditorConfig with Prettier ([2e24f7be](https://github.com/bennycode/ts-node-starter/commit/2e24f7be5f427c26d6cc8281438a6398a211b75c)) +- Replace action-dependabot-auto-merge ([86d56961](https://github.com/bennycode/ts-node-starter/commit/86d5696113c2fb4907a1666e25d1b72d698b06a5)) +- Encapsulate dependency names ([8a9e0c43](https://github.com/bennycode/ts-node-starter/commit/8a9e0c432d9665ce57e282a0b9d57d418114b060)) +- **config:** Use ESLint config from @typescripttv ([eef59275](https://github.com/bennycode/ts-node-starter/commit/eef59275e91f6f484f7a917fdd87b09318ebbad3)) +- **test:** Replace Jasmine with Jest ([#405](https://github.com/bennycode/ts-node-starter/pull/405)) ([41e9b42b](https://github.com/bennycode/ts-node-starter/commit/41e9b42bb5b7ca364dbbabf1104955090003d1be)) ##### Code Style Changes -* Enforce single attribute per line in HTML ([828c8eba](https://github.com/bennycode/ts-node-starter/commit/828c8ebae47886aebb0ef536540eb57547574628)) +- Enforce single attribute per line in HTML ([828c8eba](https://github.com/bennycode/ts-node-starter/commit/828c8ebae47886aebb0ef536540eb57547574628)) + +## 1.0.0 (2023-11-21) + +##### Documentation Changes + +- Use Vitest Globals ([cfb8e764](https://github.com/bennycode/ts-node-starter/commit/cfb8e76453baa81bffbd602bb570f16b8699657b)) +- Switch to EcmaScript Modules (ESM) ([3c6c51e4](https://github.com/bennycode/ts-node-starter/commit/3c6c51e4ee70fd44e3723f04eb7f1dc115261310)) +- Replaced Jest with Vitest ([46cd7423](https://github.com/bennycode/ts-node-starter/commit/46cd74238a84e6618b70a312c60d6ad03e98220b)) +- Replaced pretty-quick with Prettier 3 ([84267658](https://github.com/bennycode/ts-node-starter/commit/842676587b6a5f0347ac521db1022763b0905e1e)) +- Replace yarn with npm ([16dd53e6](https://github.com/bennycode/ts-node-starter/commit/16dd53e6d325c9eb4003b0b0fc440440941f7617)) +- Use direct Jest global APIs ([23206dae](https://github.com/bennycode/ts-node-starter/commit/23206daef8b23947440c1d58ba6cb1e661d78404)) +- List Shareable Config ([032bed00](https://github.com/bennycode/ts-node-starter/commit/032bed00fe630b55f485b7e223e8d94eae83bac4)) +- List important refactorings ([b227dafb](https://github.com/bennycode/ts-node-starter/commit/b227dafbfe6b7988465c2ec3ebb1ee4289a3a839)) +- Mention project name ([39ea6c3a](https://github.com/bennycode/ts-node-starter/commit/39ea6c3a05a87acf1065143ed942d9ac6dabd590)) +- Replace project name ([352ffd21](https://github.com/bennycode/ts-node-starter/commit/352ffd2169ef1040a4fa750d55f8a1af86fbd695)) +- Describe template repository ([1cc0516f](https://github.com/bennycode/ts-node-starter/commit/1cc0516f6bccf7ea7d91a8c5174bbae55a6e2c27)) + +##### New Features + +- Add docs generation ([4fbfe0f1](https://github.com/bennycode/ts-node-starter/commit/4fbfe0f170748f2368a01f8b7a94984661c88a96)) +- Reuse testing workflow ([#594](https://github.com/bennycode/ts-node-starter/pull/594)) ([00541e7f](https://github.com/bennycode/ts-node-starter/commit/00541e7f9752b99ac79011eda1fe9f50d9aca553)) +- Cancel concurrent tests ([f5a1a96a](https://github.com/bennycode/ts-node-starter/commit/f5a1a96a2472955fb995e00923e72f0eaf328616)) +- Control import statements which should be emitted into JavaScript ([767c5eb2](https://github.com/bennycode/ts-node-starter/commit/767c5eb290ec674092ca74f85467e90c4f844364)) +- Add Node.js inspector for debugging purposes ([7b36600d](https://github.com/bennycode/ts-node-starter/commit/7b36600de4e6a764e66c5d18f59232fa2faea17c)) +- Add CLI demo ([788751b4](https://github.com/bennycode/ts-node-starter/commit/788751b4ef9dbd8bcf3aca65cef76a0d8114784e)) +- Define end of line setting ([23334cef](https://github.com/bennycode/ts-node-starter/commit/23334cef695752289c2a79fac695fb4ebc6ac0f3)) +- Use auto-merge functionality ([896a2a4b](https://github.com/bennycode/ts-node-starter/commit/896a2a4bd33c76768d984efad1e2b0e33bc7ea61)) +- Automatically update GitHub Actions ([51c54dae](https://github.com/bennycode/ts-node-starter/commit/51c54dae68b416d8edc53a66381ef551a7c7c0d9)) +- Log explicit Prettier errors to console ([7d7e6388](https://github.com/bennycode/ts-node-starter/commit/7d7e63888b24592fded5226ad377cbd3deaba5c9)) +- Create releases through GitHub ([e873290c](https://github.com/bennycode/ts-node-starter/commit/e873290cda30e9c508070e497031b6f2a8c5ca61)) +- **ci:** Reduce amount of builds ([d612d21f](https://github.com/bennycode/ts-node-starter/commit/d612d21f83d5f59207c0192610df5e6ca55bcf02)) +- **test:** Pass test script without tests ([d40edc9a](https://github.com/bennycode/ts-node-starter/commit/d40edc9a9557ecfa42991c6bf5976141bf48d088)) + +##### Bug Fixes + +- Don't publish vitest config ([e44ad4c3](https://github.com/bennycode/ts-node-starter/commit/e44ad4c3b51a11c6a20a0b43abaa098f391ff067)) +- update link to CLI script ([cb492b6f](https://github.com/bennycode/ts-node-starter/commit/cb492b6fdde2f7f8ea62b74fb5be51933f9d6c23)) +- use npm install ([6f6fe9f3](https://github.com/bennycode/ts-node-starter/commit/6f6fe9f376c8830d450ed7758947a657bbe9ec22)) +- Use ts-node-esm for ES modules ([39cda170](https://github.com/bennycode/ts-node-starter/commit/39cda170d12fae2ff4b6122df2f85f04613ee99b)) +- Update deprecated Prettier option ([b83164f1](https://github.com/bennycode/ts-node-starter/commit/b83164f1dc1dfb395d452343b34b3739c6d268df)) +- forward fix command options ([2da0f1bf](https://github.com/bennycode/ts-node-starter/commit/2da0f1bfe160c1bc3a74341a24c8b0681dcdcb40)) +- Remove postinstall script to work as library ([64adc38d](https://github.com/bennycode/ts-node-starter/commit/64adc38ded8cddd78e5ebde42cc25bb53eb1c73e)) + +##### Other Changes + +- Switch to EcmaScript modules (ESM) ([#603](https://github.com/bennycode/ts-node-starter/pull/603)) ([0cae631c](https://github.com/bennycode/ts-node-starter/commit/0cae631ca6457026919418ddb3a10f7858e9ad55)) + +##### Refactors + +- Use Vitest globals ([#622](https://github.com/bennycode/ts-node-starter/pull/622)) ([6b273c3c](https://github.com/bennycode/ts-node-starter/commit/6b273c3c09552d5aa829f48987c1c1dcf7a93ce9)) +- Replaced Jest with Vitest ([#602](https://github.com/bennycode/ts-node-starter/pull/602)) ([662dddf9](https://github.com/bennycode/ts-node-starter/commit/662dddf92d418d0e1119a04d8f5fe807a7a566f0)) +- Replace pretty-quick with Prettier 3.0 ([#601](https://github.com/bennycode/ts-node-starter/pull/601)) ([7623ba89](https://github.com/bennycode/ts-node-starter/commit/7623ba894e6767d7da8ce5b8a1e2469639bcb027)) +- Follow Conventional Scripts ([#591](https://github.com/bennycode/ts-node-starter/pull/591)) ([6b3bd190](https://github.com/bennycode/ts-node-starter/commit/6b3bd1907272b4dbcd98d04a20c3052652093069)) +- Replace yarn with npm ([153b7267](https://github.com/bennycode/ts-node-starter/commit/153b726761db302fa3ba57ed1d71aabae01d8394)) +- Replace @types/jest with @jest/globals ([73c5bc24](https://github.com/bennycode/ts-node-starter/commit/73c5bc246de79ca2cc805a8b61e42bec39cb97fd)) +- Remove lint-staged ([dbafb517](https://github.com/bennycode/ts-node-starter/commit/dbafb51742a18311d32a9295ea1df5dffbea86bd)) +- Replace husky with Lefthook ([#518](https://github.com/bennycode/ts-node-starter/pull/518)) ([9c416150](https://github.com/bennycode/ts-node-starter/commit/9c4161509acf49e56042383c9ea340f68f248582)) +- Replace EditorConfig with Prettier ([2e24f7be](https://github.com/bennycode/ts-node-starter/commit/2e24f7be5f427c26d6cc8281438a6398a211b75c)) +- Replace action-dependabot-auto-merge ([86d56961](https://github.com/bennycode/ts-node-starter/commit/86d5696113c2fb4907a1666e25d1b72d698b06a5)) +- Encapsulate dependency names ([8a9e0c43](https://github.com/bennycode/ts-node-starter/commit/8a9e0c432d9665ce57e282a0b9d57d418114b060)) +- **config:** Use ESLint config from @typescripttv ([eef59275](https://github.com/bennycode/ts-node-starter/commit/eef59275e91f6f484f7a917fdd87b09318ebbad3)) +- **test:** Replace Jasmine with Jest ([#405](https://github.com/bennycode/ts-node-starter/pull/405)) ([41e9b42b](https://github.com/bennycode/ts-node-starter/commit/41e9b42bb5b7ca364dbbabf1104955090003d1be)) + +##### Code Style Changes +- Enforce single attribute per line in HTML ([828c8eba](https://github.com/bennycode/ts-node-starter/commit/828c8ebae47886aebb0ef536540eb57547574628)) diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 6367f947..20c345c5 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -1,50 +1,65 @@ :root { - --light-hl-0: #795E26; - --dark-hl-0: #DCDCAA; - --light-hl-1: #000000; - --dark-hl-1: #D4D4D4; - --light-hl-2: #A31515; - --dark-hl-2: #CE9178; - --light-hl-3: #0000FF; - --dark-hl-3: #569CD6; - --light-code-background: #FFFFFF; - --dark-code-background: #1E1E1E; + --light-hl-0: #795e26; + --dark-hl-0: #dcdcaa; + --light-hl-1: #000000; + --dark-hl-1: #d4d4d4; + --light-hl-2: #a31515; + --dark-hl-2: #ce9178; + --light-hl-3: #0000ff; + --dark-hl-3: #569cd6; + --light-code-background: #ffffff; + --dark-code-background: #1e1e1e; } -@media (prefers-color-scheme: light) { :root { +@media (prefers-color-scheme: light) { + :root { --hl-0: var(--light-hl-0); --hl-1: var(--light-hl-1); --hl-2: var(--light-hl-2); --hl-3: var(--light-hl-3); --code-background: var(--light-code-background); -} } + } +} -@media (prefers-color-scheme: dark) { :root { +@media (prefers-color-scheme: dark) { + :root { --hl-0: var(--dark-hl-0); --hl-1: var(--dark-hl-1); --hl-2: var(--dark-hl-2); --hl-3: var(--dark-hl-3); --code-background: var(--dark-code-background); -} } + } +} :root[data-theme='light'] { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --code-background: var(--light-code-background); + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --code-background: var(--light-code-background); } :root[data-theme='dark'] { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --code-background: var(--dark-code-background); + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --code-background: var(--dark-code-background); } -.hl-0 { color: var(--hl-0); } -.hl-1 { color: var(--hl-1); } -.hl-2 { color: var(--hl-2); } -.hl-3 { color: var(--hl-3); } -pre, code { background: var(--code-background); } +.hl-0 { + color: var(--hl-0); +} +.hl-1 { + color: var(--hl-1); +} +.hl-2 { + color: var(--hl-2); +} +.hl-3 { + color: var(--hl-3); +} +pre, +code { + background: var(--code-background); +} diff --git a/docs/assets/main.js b/docs/assets/main.js index d0aa8d5f..2f92f461 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,8 +1,1805 @@ -"use strict"; -"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +'use strict'; +'use strict'; +(() => { + var Pe = Object.create; + var ne = Object.defineProperty; + var Ie = Object.getOwnPropertyDescriptor; + var Oe = Object.getOwnPropertyNames; + var _e = Object.getPrototypeOf, + Re = Object.prototype.hasOwnProperty; + var Me = (t, e) => () => (e || t((e = {exports: {}}).exports, e), e.exports); + var Fe = (t, e, n, r) => { + if ((e && typeof e == 'object') || typeof e == 'function') + for (let i of Oe(e)) + !Re.call(t, i) && i !== n && ne(t, i, {get: () => e[i], enumerable: !(r = Ie(e, i)) || r.enumerable}); + return t; + }; + var De = (t, e, n) => ( + (n = t != null ? Pe(_e(t)) : {}), Fe(e || !t || !t.__esModule ? ne(n, 'default', {value: t, enumerable: !0}) : n, t) + ); + var ae = Me((se, oe) => { + (function () { + var t = function (e) { + var n = new t.Builder(); + return ( + n.pipeline.add(t.trimmer, t.stopWordFilter, t.stemmer), + n.searchPipeline.add(t.stemmer), + e.call(n, n), + n.build() + ); + }; + t.version = '2.3.9'; + (t.utils = {}), + (t.utils.warn = (function (e) { + return function (n) { + e.console && console.warn && console.warn(n); + }; + })(this)), + (t.utils.asString = function (e) { + return e == null ? '' : e.toString(); + }), + (t.utils.clone = function (e) { + if (e == null) return e; + for (var n = Object.create(null), r = Object.keys(e), i = 0; i < r.length; i++) { + var s = r[i], + o = e[s]; + if (Array.isArray(o)) { + n[s] = o.slice(); + continue; + } + if (typeof o == 'string' || typeof o == 'number' || typeof o == 'boolean') { + n[s] = o; + continue; + } + throw new TypeError('clone is not deep and does not support nested objects'); + } + return n; + }), + (t.FieldRef = function (e, n, r) { + (this.docRef = e), (this.fieldName = n), (this._stringValue = r); + }), + (t.FieldRef.joiner = '/'), + (t.FieldRef.fromString = function (e) { + var n = e.indexOf(t.FieldRef.joiner); + if (n === -1) throw 'malformed field ref string'; + var r = e.slice(0, n), + i = e.slice(n + 1); + return new t.FieldRef(i, r, e); + }), + (t.FieldRef.prototype.toString = function () { + return ( + this._stringValue == null && (this._stringValue = this.fieldName + t.FieldRef.joiner + this.docRef), + this._stringValue + ); + }); + (t.Set = function (e) { + if (((this.elements = Object.create(null)), e)) { + this.length = e.length; + for (var n = 0; n < this.length; n++) this.elements[e[n]] = !0; + } else this.length = 0; + }), + (t.Set.complete = { + intersect: function (e) { + return e; + }, + union: function () { + return this; + }, + contains: function () { + return !0; + }, + }), + (t.Set.empty = { + intersect: function () { + return this; + }, + union: function (e) { + return e; + }, + contains: function () { + return !1; + }, + }), + (t.Set.prototype.contains = function (e) { + return !!this.elements[e]; + }), + (t.Set.prototype.intersect = function (e) { + var n, + r, + i, + s = []; + if (e === t.Set.complete) return this; + if (e === t.Set.empty) return e; + this.length < e.length ? ((n = this), (r = e)) : ((n = e), (r = this)), (i = Object.keys(n.elements)); + for (var o = 0; o < i.length; o++) { + var a = i[o]; + a in r.elements && s.push(a); + } + return new t.Set(s); + }), + (t.Set.prototype.union = function (e) { + return e === t.Set.complete + ? t.Set.complete + : e === t.Set.empty + ? this + : new t.Set(Object.keys(this.elements).concat(Object.keys(e.elements))); + }), + (t.idf = function (e, n) { + var r = 0; + for (var i in e) i != '_index' && (r += Object.keys(e[i]).length); + var s = (n - r + 0.5) / (r + 0.5); + return Math.log(1 + Math.abs(s)); + }), + (t.Token = function (e, n) { + (this.str = e || ''), (this.metadata = n || {}); + }), + (t.Token.prototype.toString = function () { + return this.str; + }), + (t.Token.prototype.update = function (e) { + return (this.str = e(this.str, this.metadata)), this; + }), + (t.Token.prototype.clone = function (e) { + return ( + (e = + e || + function (n) { + return n; + }), + new t.Token(e(this.str, this.metadata), this.metadata) + ); + }); + (t.tokenizer = function (e, n) { + if (e == null || e == null) return []; + if (Array.isArray(e)) + return e.map(function (v) { + return new t.Token(t.utils.asString(v).toLowerCase(), t.utils.clone(n)); + }); + for (var r = e.toString().toLowerCase(), i = r.length, s = [], o = 0, a = 0; o <= i; o++) { + var l = r.charAt(o), + u = o - a; + if (l.match(t.tokenizer.separator) || o == i) { + if (u > 0) { + var d = t.utils.clone(n) || {}; + (d.position = [a, u]), (d.index = s.length), s.push(new t.Token(r.slice(a, o), d)); + } + a = o + 1; + } + } + return s; + }), + (t.tokenizer.separator = /[\s\-]+/); + (t.Pipeline = function () { + this._stack = []; + }), + (t.Pipeline.registeredFunctions = Object.create(null)), + (t.Pipeline.registerFunction = function (e, n) { + n in this.registeredFunctions && t.utils.warn('Overwriting existing registered function: ' + n), + (e.label = n), + (t.Pipeline.registeredFunctions[e.label] = e); + }), + (t.Pipeline.warnIfFunctionNotRegistered = function (e) { + var n = e.label && e.label in this.registeredFunctions; + n || + t.utils.warn( + `Function is not registered with pipeline. This may cause problems when serialising the index. +`, + e + ); + }), + (t.Pipeline.load = function (e) { + var n = new t.Pipeline(); + return ( + e.forEach(function (r) { + var i = t.Pipeline.registeredFunctions[r]; + if (i) n.add(i); + else throw new Error('Cannot load unregistered function: ' + r); + }), + n + ); + }), + (t.Pipeline.prototype.add = function () { + var e = Array.prototype.slice.call(arguments); + e.forEach(function (n) { + t.Pipeline.warnIfFunctionNotRegistered(n), this._stack.push(n); + }, this); + }), + (t.Pipeline.prototype.after = function (e, n) { + t.Pipeline.warnIfFunctionNotRegistered(n); + var r = this._stack.indexOf(e); + if (r == -1) throw new Error('Cannot find existingFn'); + (r = r + 1), this._stack.splice(r, 0, n); + }), + (t.Pipeline.prototype.before = function (e, n) { + t.Pipeline.warnIfFunctionNotRegistered(n); + var r = this._stack.indexOf(e); + if (r == -1) throw new Error('Cannot find existingFn'); + this._stack.splice(r, 0, n); + }), + (t.Pipeline.prototype.remove = function (e) { + var n = this._stack.indexOf(e); + n != -1 && this._stack.splice(n, 1); + }), + (t.Pipeline.prototype.run = function (e) { + for (var n = this._stack.length, r = 0; r < n; r++) { + for (var i = this._stack[r], s = [], o = 0; o < e.length; o++) { + var a = i(e[o], o, e); + if (!(a == null || a === '')) + if (Array.isArray(a)) for (var l = 0; l < a.length; l++) s.push(a[l]); + else s.push(a); + } + e = s; + } + return e; + }), + (t.Pipeline.prototype.runString = function (e, n) { + var r = new t.Token(e, n); + return this.run([r]).map(function (i) { + return i.toString(); + }); + }), + (t.Pipeline.prototype.reset = function () { + this._stack = []; + }), + (t.Pipeline.prototype.toJSON = function () { + return this._stack.map(function (e) { + return t.Pipeline.warnIfFunctionNotRegistered(e), e.label; + }); + }); + (t.Vector = function (e) { + (this._magnitude = 0), (this.elements = e || []); + }), + (t.Vector.prototype.positionForIndex = function (e) { + if (this.elements.length == 0) return 0; + for ( + var n = 0, r = this.elements.length / 2, i = r - n, s = Math.floor(i / 2), o = this.elements[s * 2]; + i > 1 && (o < e && (n = s), o > e && (r = s), o != e); + + ) + (i = r - n), (s = n + Math.floor(i / 2)), (o = this.elements[s * 2]); + if (o == e || o > e) return s * 2; + if (o < e) return (s + 1) * 2; + }), + (t.Vector.prototype.insert = function (e, n) { + this.upsert(e, n, function () { + throw 'duplicate index'; + }); + }), + (t.Vector.prototype.upsert = function (e, n, r) { + this._magnitude = 0; + var i = this.positionForIndex(e); + this.elements[i] == e + ? (this.elements[i + 1] = r(this.elements[i + 1], n)) + : this.elements.splice(i, 0, e, n); + }), + (t.Vector.prototype.magnitude = function () { + if (this._magnitude) return this._magnitude; + for (var e = 0, n = this.elements.length, r = 1; r < n; r += 2) { + var i = this.elements[r]; + e += i * i; + } + return (this._magnitude = Math.sqrt(e)); + }), + (t.Vector.prototype.dot = function (e) { + for ( + var n = 0, r = this.elements, i = e.elements, s = r.length, o = i.length, a = 0, l = 0, u = 0, d = 0; + u < s && d < o; + + ) + (a = r[u]), + (l = i[d]), + a < l ? (u += 2) : a > l ? (d += 2) : a == l && ((n += r[u + 1] * i[d + 1]), (u += 2), (d += 2)); + return n; + }), + (t.Vector.prototype.similarity = function (e) { + return this.dot(e) / this.magnitude() || 0; + }), + (t.Vector.prototype.toArray = function () { + for (var e = new Array(this.elements.length / 2), n = 1, r = 0; n < this.elements.length; n += 2, r++) + e[r] = this.elements[n]; + return e; + }), + (t.Vector.prototype.toJSON = function () { + return this.elements; + }); + (t.stemmer = (function () { + var e = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log', + }, + n = {icate: 'ic', ative: '', alize: 'al', iciti: 'ic', ical: 'ic', ful: '', ness: ''}, + r = '[^aeiou]', + i = '[aeiouy]', + s = r + '[^aeiouy]*', + o = i + '[aeiou]*', + a = '^(' + s + ')?' + o + s, + l = '^(' + s + ')?' + o + s + '(' + o + ')?$', + u = '^(' + s + ')?' + o + s + o + s, + d = '^(' + s + ')?' + i, + v = new RegExp(a), + f = new RegExp(u), + b = new RegExp(l), + g = new RegExp(d), + L = /^(.+?)(ss|i)es$/, + p = /^(.+?)([^s])s$/, + m = /^(.+?)eed$/, + S = /^(.+?)(ed|ing)$/, + w = /.$/, + k = /(at|bl|iz)$/, + _ = new RegExp('([^aeiouylsz])\\1$'), + H = new RegExp('^' + s + i + '[^aeiouwxy]$'), + A = /^(.+?[^aeiou])y$/, + j = + /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/, + $ = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/, + N = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/, + q = /^(.+?)(s|t)(ion)$/, + P = /^(.+?)e$/, + z = /ll$/, + W = new RegExp('^' + s + i + '[^aeiouwxy]$'), + V = function (c) { + var y, I, T, h, x, O, M; + if (c.length < 3) return c; + if ( + ((T = c.substr(0, 1)), + T == 'y' && (c = T.toUpperCase() + c.substr(1)), + (h = L), + (x = p), + h.test(c) ? (c = c.replace(h, '$1$2')) : x.test(c) && (c = c.replace(x, '$1$2')), + (h = m), + (x = S), + h.test(c)) + ) { + var E = h.exec(c); + (h = v), h.test(E[1]) && ((h = w), (c = c.replace(h, ''))); + } else if (x.test(c)) { + var E = x.exec(c); + (y = E[1]), + (x = g), + x.test(y) && + ((c = y), + (x = k), + (O = _), + (M = H), + x.test(c) + ? (c = c + 'e') + : O.test(c) + ? ((h = w), (c = c.replace(h, ''))) + : M.test(c) && (c = c + 'e')); + } + if (((h = A), h.test(c))) { + var E = h.exec(c); + (y = E[1]), (c = y + 'i'); + } + if (((h = j), h.test(c))) { + var E = h.exec(c); + (y = E[1]), (I = E[2]), (h = v), h.test(y) && (c = y + e[I]); + } + if (((h = $), h.test(c))) { + var E = h.exec(c); + (y = E[1]), (I = E[2]), (h = v), h.test(y) && (c = y + n[I]); + } + if (((h = N), (x = q), h.test(c))) { + var E = h.exec(c); + (y = E[1]), (h = f), h.test(y) && (c = y); + } else if (x.test(c)) { + var E = x.exec(c); + (y = E[1] + E[2]), (x = f), x.test(y) && (c = y); + } + if (((h = P), h.test(c))) { + var E = h.exec(c); + (y = E[1]), (h = f), (x = b), (O = W), (h.test(y) || (x.test(y) && !O.test(y))) && (c = y); + } + return ( + (h = z), + (x = f), + h.test(c) && x.test(c) && ((h = w), (c = c.replace(h, ''))), + T == 'y' && (c = T.toLowerCase() + c.substr(1)), + c + ); + }; + return function (R) { + return R.update(V); + }; + })()), + t.Pipeline.registerFunction(t.stemmer, 'stemmer'); + (t.generateStopWordFilter = function (e) { + var n = e.reduce(function (r, i) { + return (r[i] = i), r; + }, {}); + return function (r) { + if (r && n[r.toString()] !== r.toString()) return r; + }; + }), + (t.stopWordFilter = t.generateStopWordFilter([ + 'a', + 'able', + 'about', + 'across', + 'after', + 'all', + 'almost', + 'also', + 'am', + 'among', + 'an', + 'and', + 'any', + 'are', + 'as', + 'at', + 'be', + 'because', + 'been', + 'but', + 'by', + 'can', + 'cannot', + 'could', + 'dear', + 'did', + 'do', + 'does', + 'either', + 'else', + 'ever', + 'every', + 'for', + 'from', + 'get', + 'got', + 'had', + 'has', + 'have', + 'he', + 'her', + 'hers', + 'him', + 'his', + 'how', + 'however', + 'i', + 'if', + 'in', + 'into', + 'is', + 'it', + 'its', + 'just', + 'least', + 'let', + 'like', + 'likely', + 'may', + 'me', + 'might', + 'most', + 'must', + 'my', + 'neither', + 'no', + 'nor', + 'not', + 'of', + 'off', + 'often', + 'on', + 'only', + 'or', + 'other', + 'our', + 'own', + 'rather', + 'said', + 'say', + 'says', + 'she', + 'should', + 'since', + 'so', + 'some', + 'than', + 'that', + 'the', + 'their', + 'them', + 'then', + 'there', + 'these', + 'they', + 'this', + 'tis', + 'to', + 'too', + 'twas', + 'us', + 'wants', + 'was', + 'we', + 'were', + 'what', + 'when', + 'where', + 'which', + 'while', + 'who', + 'whom', + 'why', + 'will', + 'with', + 'would', + 'yet', + 'you', + 'your', + ])), + t.Pipeline.registerFunction(t.stopWordFilter, 'stopWordFilter'); + (t.trimmer = function (e) { + return e.update(function (n) { + return n.replace(/^\W+/, '').replace(/\W+$/, ''); + }); + }), + t.Pipeline.registerFunction(t.trimmer, 'trimmer'); + (t.TokenSet = function () { + (this.final = !1), (this.edges = {}), (this.id = t.TokenSet._nextId), (t.TokenSet._nextId += 1); + }), + (t.TokenSet._nextId = 1), + (t.TokenSet.fromArray = function (e) { + for (var n = new t.TokenSet.Builder(), r = 0, i = e.length; r < i; r++) n.insert(e[r]); + return n.finish(), n.root; + }), + (t.TokenSet.fromClause = function (e) { + return 'editDistance' in e + ? t.TokenSet.fromFuzzyString(e.term, e.editDistance) + : t.TokenSet.fromString(e.term); + }), + (t.TokenSet.fromFuzzyString = function (e, n) { + for (var r = new t.TokenSet(), i = [{node: r, editsRemaining: n, str: e}]; i.length; ) { + var s = i.pop(); + if (s.str.length > 0) { + var o = s.str.charAt(0), + a; + o in s.node.edges ? (a = s.node.edges[o]) : ((a = new t.TokenSet()), (s.node.edges[o] = a)), + s.str.length == 1 && (a.final = !0), + i.push({node: a, editsRemaining: s.editsRemaining, str: s.str.slice(1)}); + } + if (s.editsRemaining != 0) { + if ('*' in s.node.edges) var l = s.node.edges['*']; + else { + var l = new t.TokenSet(); + s.node.edges['*'] = l; + } + if ( + (s.str.length == 0 && (l.final = !0), + i.push({node: l, editsRemaining: s.editsRemaining - 1, str: s.str}), + s.str.length > 1 && i.push({node: s.node, editsRemaining: s.editsRemaining - 1, str: s.str.slice(1)}), + s.str.length == 1 && (s.node.final = !0), + s.str.length >= 1) + ) { + if ('*' in s.node.edges) var u = s.node.edges['*']; + else { + var u = new t.TokenSet(); + s.node.edges['*'] = u; + } + s.str.length == 1 && (u.final = !0), + i.push({node: u, editsRemaining: s.editsRemaining - 1, str: s.str.slice(1)}); + } + if (s.str.length > 1) { + var d = s.str.charAt(0), + v = s.str.charAt(1), + f; + v in s.node.edges ? (f = s.node.edges[v]) : ((f = new t.TokenSet()), (s.node.edges[v] = f)), + s.str.length == 1 && (f.final = !0), + i.push({node: f, editsRemaining: s.editsRemaining - 1, str: d + s.str.slice(2)}); + } + } + } + return r; + }), + (t.TokenSet.fromString = function (e) { + for (var n = new t.TokenSet(), r = n, i = 0, s = e.length; i < s; i++) { + var o = e[i], + a = i == s - 1; + if (o == '*') (n.edges[o] = n), (n.final = a); + else { + var l = new t.TokenSet(); + (l.final = a), (n.edges[o] = l), (n = l); + } + } + return r; + }), + (t.TokenSet.prototype.toArray = function () { + for (var e = [], n = [{prefix: '', node: this}]; n.length; ) { + var r = n.pop(), + i = Object.keys(r.node.edges), + s = i.length; + r.node.final && (r.prefix.charAt(0), e.push(r.prefix)); + for (var o = 0; o < s; o++) { + var a = i[o]; + n.push({prefix: r.prefix.concat(a), node: r.node.edges[a]}); + } + } + return e; + }), + (t.TokenSet.prototype.toString = function () { + if (this._str) return this._str; + for (var e = this.final ? '1' : '0', n = Object.keys(this.edges).sort(), r = n.length, i = 0; i < r; i++) { + var s = n[i], + o = this.edges[s]; + e = e + s + o.id; + } + return e; + }), + (t.TokenSet.prototype.intersect = function (e) { + for (var n = new t.TokenSet(), r = void 0, i = [{qNode: e, output: n, node: this}]; i.length; ) { + r = i.pop(); + for ( + var s = Object.keys(r.qNode.edges), o = s.length, a = Object.keys(r.node.edges), l = a.length, u = 0; + u < o; + u++ + ) + for (var d = s[u], v = 0; v < l; v++) { + var f = a[v]; + if (f == d || d == '*') { + var b = r.node.edges[f], + g = r.qNode.edges[d], + L = b.final && g.final, + p = void 0; + f in r.output.edges + ? ((p = r.output.edges[f]), (p.final = p.final || L)) + : ((p = new t.TokenSet()), (p.final = L), (r.output.edges[f] = p)), + i.push({qNode: g, output: p, node: b}); + } + } + } + return n; + }), + (t.TokenSet.Builder = function () { + (this.previousWord = ''), + (this.root = new t.TokenSet()), + (this.uncheckedNodes = []), + (this.minimizedNodes = {}); + }), + (t.TokenSet.Builder.prototype.insert = function (e) { + var n, + r = 0; + if (e < this.previousWord) throw new Error('Out of order word insertion'); + for (var i = 0; i < e.length && i < this.previousWord.length && e[i] == this.previousWord[i]; i++) r++; + this.minimize(r), + this.uncheckedNodes.length == 0 + ? (n = this.root) + : (n = this.uncheckedNodes[this.uncheckedNodes.length - 1].child); + for (var i = r; i < e.length; i++) { + var s = new t.TokenSet(), + o = e[i]; + (n.edges[o] = s), this.uncheckedNodes.push({parent: n, char: o, child: s}), (n = s); + } + (n.final = !0), (this.previousWord = e); + }), + (t.TokenSet.Builder.prototype.finish = function () { + this.minimize(0); + }), + (t.TokenSet.Builder.prototype.minimize = function (e) { + for (var n = this.uncheckedNodes.length - 1; n >= e; n--) { + var r = this.uncheckedNodes[n], + i = r.child.toString(); + i in this.minimizedNodes + ? (r.parent.edges[r.char] = this.minimizedNodes[i]) + : ((r.child._str = i), (this.minimizedNodes[i] = r.child)), + this.uncheckedNodes.pop(); + } + }); + (t.Index = function (e) { + (this.invertedIndex = e.invertedIndex), + (this.fieldVectors = e.fieldVectors), + (this.tokenSet = e.tokenSet), + (this.fields = e.fields), + (this.pipeline = e.pipeline); + }), + (t.Index.prototype.search = function (e) { + return this.query(function (n) { + var r = new t.QueryParser(e, n); + r.parse(); + }); + }), + (t.Index.prototype.query = function (e) { + for ( + var n = new t.Query(this.fields), + r = Object.create(null), + i = Object.create(null), + s = Object.create(null), + o = Object.create(null), + a = Object.create(null), + l = 0; + l < this.fields.length; + l++ + ) + i[this.fields[l]] = new t.Vector(); + e.call(n, n); + for (var l = 0; l < n.clauses.length; l++) { + var u = n.clauses[l], + d = null, + v = t.Set.empty; + u.usePipeline ? (d = this.pipeline.runString(u.term, {fields: u.fields})) : (d = [u.term]); + for (var f = 0; f < d.length; f++) { + var b = d[f]; + u.term = b; + var g = t.TokenSet.fromClause(u), + L = this.tokenSet.intersect(g).toArray(); + if (L.length === 0 && u.presence === t.Query.presence.REQUIRED) { + for (var p = 0; p < u.fields.length; p++) { + var m = u.fields[p]; + o[m] = t.Set.empty; + } + break; + } + for (var S = 0; S < L.length; S++) + for (var w = L[S], k = this.invertedIndex[w], _ = k._index, p = 0; p < u.fields.length; p++) { + var m = u.fields[p], + H = k[m], + A = Object.keys(H), + j = w + '/' + m, + $ = new t.Set(A); + if ( + (u.presence == t.Query.presence.REQUIRED && + ((v = v.union($)), o[m] === void 0 && (o[m] = t.Set.complete)), + u.presence == t.Query.presence.PROHIBITED) + ) { + a[m] === void 0 && (a[m] = t.Set.empty), (a[m] = a[m].union($)); + continue; + } + if ( + (i[m].upsert(_, u.boost, function (Qe, Ce) { + return Qe + Ce; + }), + !s[j]) + ) { + for (var N = 0; N < A.length; N++) { + var q = A[N], + P = new t.FieldRef(q, m), + z = H[q], + W; + (W = r[P]) === void 0 ? (r[P] = new t.MatchData(w, m, z)) : W.add(w, m, z); + } + s[j] = !0; + } + } + } + if (u.presence === t.Query.presence.REQUIRED) + for (var p = 0; p < u.fields.length; p++) { + var m = u.fields[p]; + o[m] = o[m].intersect(v); + } + } + for (var V = t.Set.complete, R = t.Set.empty, l = 0; l < this.fields.length; l++) { + var m = this.fields[l]; + o[m] && (V = V.intersect(o[m])), a[m] && (R = R.union(a[m])); + } + var c = Object.keys(r), + y = [], + I = Object.create(null); + if (n.isNegated()) { + c = Object.keys(this.fieldVectors); + for (var l = 0; l < c.length; l++) { + var P = c[l], + T = t.FieldRef.fromString(P); + r[P] = new t.MatchData(); + } + } + for (var l = 0; l < c.length; l++) { + var T = t.FieldRef.fromString(c[l]), + h = T.docRef; + if (V.contains(h) && !R.contains(h)) { + var x = this.fieldVectors[T], + O = i[T.fieldName].similarity(x), + M; + if ((M = I[h]) !== void 0) (M.score += O), M.matchData.combine(r[T]); + else { + var E = {ref: h, score: O, matchData: r[T]}; + (I[h] = E), y.push(E); + } + } + } + return y.sort(function (Te, ke) { + return ke.score - Te.score; + }); + }), + (t.Index.prototype.toJSON = function () { + var e = Object.keys(this.invertedIndex) + .sort() + .map(function (r) { + return [r, this.invertedIndex[r]]; + }, this), + n = Object.keys(this.fieldVectors).map(function (r) { + return [r, this.fieldVectors[r].toJSON()]; + }, this); + return { + version: t.version, + fields: this.fields, + fieldVectors: n, + invertedIndex: e, + pipeline: this.pipeline.toJSON(), + }; + }), + (t.Index.load = function (e) { + var n = {}, + r = {}, + i = e.fieldVectors, + s = Object.create(null), + o = e.invertedIndex, + a = new t.TokenSet.Builder(), + l = t.Pipeline.load(e.pipeline); + e.version != t.version && + t.utils.warn( + "Version mismatch when loading serialised index. Current version of lunr '" + + t.version + + "' does not match serialized index '" + + e.version + + "'" + ); + for (var u = 0; u < i.length; u++) { + var d = i[u], + v = d[0], + f = d[1]; + r[v] = new t.Vector(f); + } + for (var u = 0; u < o.length; u++) { + var d = o[u], + b = d[0], + g = d[1]; + a.insert(b), (s[b] = g); + } + return ( + a.finish(), + (n.fields = e.fields), + (n.fieldVectors = r), + (n.invertedIndex = s), + (n.tokenSet = a.root), + (n.pipeline = l), + new t.Index(n) + ); + }); + (t.Builder = function () { + (this._ref = 'id'), + (this._fields = Object.create(null)), + (this._documents = Object.create(null)), + (this.invertedIndex = Object.create(null)), + (this.fieldTermFrequencies = {}), + (this.fieldLengths = {}), + (this.tokenizer = t.tokenizer), + (this.pipeline = new t.Pipeline()), + (this.searchPipeline = new t.Pipeline()), + (this.documentCount = 0), + (this._b = 0.75), + (this._k1 = 1.2), + (this.termIndex = 0), + (this.metadataWhitelist = []); + }), + (t.Builder.prototype.ref = function (e) { + this._ref = e; + }), + (t.Builder.prototype.field = function (e, n) { + if (/\//.test(e)) throw new RangeError("Field '" + e + "' contains illegal character '/'"); + this._fields[e] = n || {}; + }), + (t.Builder.prototype.b = function (e) { + e < 0 ? (this._b = 0) : e > 1 ? (this._b = 1) : (this._b = e); + }), + (t.Builder.prototype.k1 = function (e) { + this._k1 = e; + }), + (t.Builder.prototype.add = function (e, n) { + var r = e[this._ref], + i = Object.keys(this._fields); + (this._documents[r] = n || {}), (this.documentCount += 1); + for (var s = 0; s < i.length; s++) { + var o = i[s], + a = this._fields[o].extractor, + l = a ? a(e) : e[o], + u = this.tokenizer(l, {fields: [o]}), + d = this.pipeline.run(u), + v = new t.FieldRef(r, o), + f = Object.create(null); + (this.fieldTermFrequencies[v] = f), (this.fieldLengths[v] = 0), (this.fieldLengths[v] += d.length); + for (var b = 0; b < d.length; b++) { + var g = d[b]; + if ((f[g] == null && (f[g] = 0), (f[g] += 1), this.invertedIndex[g] == null)) { + var L = Object.create(null); + (L._index = this.termIndex), (this.termIndex += 1); + for (var p = 0; p < i.length; p++) L[i[p]] = Object.create(null); + this.invertedIndex[g] = L; + } + this.invertedIndex[g][o][r] == null && (this.invertedIndex[g][o][r] = Object.create(null)); + for (var m = 0; m < this.metadataWhitelist.length; m++) { + var S = this.metadataWhitelist[m], + w = g.metadata[S]; + this.invertedIndex[g][o][r][S] == null && (this.invertedIndex[g][o][r][S] = []), + this.invertedIndex[g][o][r][S].push(w); + } + } + } + }), + (t.Builder.prototype.calculateAverageFieldLengths = function () { + for (var e = Object.keys(this.fieldLengths), n = e.length, r = {}, i = {}, s = 0; s < n; s++) { + var o = t.FieldRef.fromString(e[s]), + a = o.fieldName; + i[a] || (i[a] = 0), (i[a] += 1), r[a] || (r[a] = 0), (r[a] += this.fieldLengths[o]); + } + for (var l = Object.keys(this._fields), s = 0; s < l.length; s++) { + var u = l[s]; + r[u] = r[u] / i[u]; + } + this.averageFieldLength = r; + }), + (t.Builder.prototype.createFieldVectors = function () { + for ( + var e = {}, n = Object.keys(this.fieldTermFrequencies), r = n.length, i = Object.create(null), s = 0; + s < r; + s++ + ) { + for ( + var o = t.FieldRef.fromString(n[s]), + a = o.fieldName, + l = this.fieldLengths[o], + u = new t.Vector(), + d = this.fieldTermFrequencies[o], + v = Object.keys(d), + f = v.length, + b = this._fields[a].boost || 1, + g = this._documents[o.docRef].boost || 1, + L = 0; + L < f; + L++ + ) { + var p = v[L], + m = d[p], + S = this.invertedIndex[p]._index, + w, + k, + _; + i[p] === void 0 ? ((w = t.idf(this.invertedIndex[p], this.documentCount)), (i[p] = w)) : (w = i[p]), + (k = + (w * ((this._k1 + 1) * m)) / + (this._k1 * (1 - this._b + this._b * (l / this.averageFieldLength[a])) + m)), + (k *= b), + (k *= g), + (_ = Math.round(k * 1e3) / 1e3), + u.insert(S, _); + } + e[o] = u; + } + this.fieldVectors = e; + }), + (t.Builder.prototype.createTokenSet = function () { + this.tokenSet = t.TokenSet.fromArray(Object.keys(this.invertedIndex).sort()); + }), + (t.Builder.prototype.build = function () { + return ( + this.calculateAverageFieldLengths(), + this.createFieldVectors(), + this.createTokenSet(), + new t.Index({ + invertedIndex: this.invertedIndex, + fieldVectors: this.fieldVectors, + tokenSet: this.tokenSet, + fields: Object.keys(this._fields), + pipeline: this.searchPipeline, + }) + ); + }), + (t.Builder.prototype.use = function (e) { + var n = Array.prototype.slice.call(arguments, 1); + n.unshift(this), e.apply(this, n); + }), + (t.MatchData = function (e, n, r) { + for (var i = Object.create(null), s = Object.keys(r || {}), o = 0; o < s.length; o++) { + var a = s[o]; + i[a] = r[a].slice(); + } + (this.metadata = Object.create(null)), + e !== void 0 && ((this.metadata[e] = Object.create(null)), (this.metadata[e][n] = i)); + }), + (t.MatchData.prototype.combine = function (e) { + for (var n = Object.keys(e.metadata), r = 0; r < n.length; r++) { + var i = n[r], + s = Object.keys(e.metadata[i]); + this.metadata[i] == null && (this.metadata[i] = Object.create(null)); + for (var o = 0; o < s.length; o++) { + var a = s[o], + l = Object.keys(e.metadata[i][a]); + this.metadata[i][a] == null && (this.metadata[i][a] = Object.create(null)); + for (var u = 0; u < l.length; u++) { + var d = l[u]; + this.metadata[i][a][d] == null + ? (this.metadata[i][a][d] = e.metadata[i][a][d]) + : (this.metadata[i][a][d] = this.metadata[i][a][d].concat(e.metadata[i][a][d])); + } + } + } + }), + (t.MatchData.prototype.add = function (e, n, r) { + if (!(e in this.metadata)) { + (this.metadata[e] = Object.create(null)), (this.metadata[e][n] = r); + return; + } + if (!(n in this.metadata[e])) { + this.metadata[e][n] = r; + return; + } + for (var i = Object.keys(r), s = 0; s < i.length; s++) { + var o = i[s]; + o in this.metadata[e][n] + ? (this.metadata[e][n][o] = this.metadata[e][n][o].concat(r[o])) + : (this.metadata[e][n][o] = r[o]); + } + }), + (t.Query = function (e) { + (this.clauses = []), (this.allFields = e); + }), + (t.Query.wildcard = new String('*')), + (t.Query.wildcard.NONE = 0), + (t.Query.wildcard.LEADING = 1), + (t.Query.wildcard.TRAILING = 2), + (t.Query.presence = {OPTIONAL: 1, REQUIRED: 2, PROHIBITED: 3}), + (t.Query.prototype.clause = function (e) { + return ( + 'fields' in e || (e.fields = this.allFields), + 'boost' in e || (e.boost = 1), + 'usePipeline' in e || (e.usePipeline = !0), + 'wildcard' in e || (e.wildcard = t.Query.wildcard.NONE), + e.wildcard & t.Query.wildcard.LEADING && e.term.charAt(0) != t.Query.wildcard && (e.term = '*' + e.term), + e.wildcard & t.Query.wildcard.TRAILING && + e.term.slice(-1) != t.Query.wildcard && + (e.term = '' + e.term + '*'), + 'presence' in e || (e.presence = t.Query.presence.OPTIONAL), + this.clauses.push(e), + this + ); + }), + (t.Query.prototype.isNegated = function () { + for (var e = 0; e < this.clauses.length; e++) + if (this.clauses[e].presence != t.Query.presence.PROHIBITED) return !1; + return !0; + }), + (t.Query.prototype.term = function (e, n) { + if (Array.isArray(e)) + return ( + e.forEach(function (i) { + this.term(i, t.utils.clone(n)); + }, this), + this + ); + var r = n || {}; + return (r.term = e.toString()), this.clause(r), this; + }), + (t.QueryParseError = function (e, n, r) { + (this.name = 'QueryParseError'), (this.message = e), (this.start = n), (this.end = r); + }), + (t.QueryParseError.prototype = new Error()), + (t.QueryLexer = function (e) { + (this.lexemes = []), + (this.str = e), + (this.length = e.length), + (this.pos = 0), + (this.start = 0), + (this.escapeCharPositions = []); + }), + (t.QueryLexer.prototype.run = function () { + for (var e = t.QueryLexer.lexText; e; ) e = e(this); + }), + (t.QueryLexer.prototype.sliceString = function () { + for (var e = [], n = this.start, r = this.pos, i = 0; i < this.escapeCharPositions.length; i++) + (r = this.escapeCharPositions[i]), e.push(this.str.slice(n, r)), (n = r + 1); + return e.push(this.str.slice(n, this.pos)), (this.escapeCharPositions.length = 0), e.join(''); + }), + (t.QueryLexer.prototype.emit = function (e) { + this.lexemes.push({type: e, str: this.sliceString(), start: this.start, end: this.pos}), + (this.start = this.pos); + }), + (t.QueryLexer.prototype.escapeCharacter = function () { + this.escapeCharPositions.push(this.pos - 1), (this.pos += 1); + }), + (t.QueryLexer.prototype.next = function () { + if (this.pos >= this.length) return t.QueryLexer.EOS; + var e = this.str.charAt(this.pos); + return (this.pos += 1), e; + }), + (t.QueryLexer.prototype.width = function () { + return this.pos - this.start; + }), + (t.QueryLexer.prototype.ignore = function () { + this.start == this.pos && (this.pos += 1), (this.start = this.pos); + }), + (t.QueryLexer.prototype.backup = function () { + this.pos -= 1; + }), + (t.QueryLexer.prototype.acceptDigitRun = function () { + var e, n; + do (e = this.next()), (n = e.charCodeAt(0)); + while (n > 47 && n < 58); + e != t.QueryLexer.EOS && this.backup(); + }), + (t.QueryLexer.prototype.more = function () { + return this.pos < this.length; + }), + (t.QueryLexer.EOS = 'EOS'), + (t.QueryLexer.FIELD = 'FIELD'), + (t.QueryLexer.TERM = 'TERM'), + (t.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE'), + (t.QueryLexer.BOOST = 'BOOST'), + (t.QueryLexer.PRESENCE = 'PRESENCE'), + (t.QueryLexer.lexField = function (e) { + return e.backup(), e.emit(t.QueryLexer.FIELD), e.ignore(), t.QueryLexer.lexText; + }), + (t.QueryLexer.lexTerm = function (e) { + if ((e.width() > 1 && (e.backup(), e.emit(t.QueryLexer.TERM)), e.ignore(), e.more())) + return t.QueryLexer.lexText; + }), + (t.QueryLexer.lexEditDistance = function (e) { + return e.ignore(), e.acceptDigitRun(), e.emit(t.QueryLexer.EDIT_DISTANCE), t.QueryLexer.lexText; + }), + (t.QueryLexer.lexBoost = function (e) { + return e.ignore(), e.acceptDigitRun(), e.emit(t.QueryLexer.BOOST), t.QueryLexer.lexText; + }), + (t.QueryLexer.lexEOS = function (e) { + e.width() > 0 && e.emit(t.QueryLexer.TERM); + }), + (t.QueryLexer.termSeparator = t.tokenizer.separator), + (t.QueryLexer.lexText = function (e) { + for (;;) { + var n = e.next(); + if (n == t.QueryLexer.EOS) return t.QueryLexer.lexEOS; + if (n.charCodeAt(0) == 92) { + e.escapeCharacter(); + continue; + } + if (n == ':') return t.QueryLexer.lexField; + if (n == '~') return e.backup(), e.width() > 0 && e.emit(t.QueryLexer.TERM), t.QueryLexer.lexEditDistance; + if (n == '^') return e.backup(), e.width() > 0 && e.emit(t.QueryLexer.TERM), t.QueryLexer.lexBoost; + if ((n == '+' && e.width() === 1) || (n == '-' && e.width() === 1)) + return e.emit(t.QueryLexer.PRESENCE), t.QueryLexer.lexText; + if (n.match(t.QueryLexer.termSeparator)) return t.QueryLexer.lexTerm; + } + }), + (t.QueryParser = function (e, n) { + (this.lexer = new t.QueryLexer(e)), (this.query = n), (this.currentClause = {}), (this.lexemeIdx = 0); + }), + (t.QueryParser.prototype.parse = function () { + this.lexer.run(), (this.lexemes = this.lexer.lexemes); + for (var e = t.QueryParser.parseClause; e; ) e = e(this); + return this.query; + }), + (t.QueryParser.prototype.peekLexeme = function () { + return this.lexemes[this.lexemeIdx]; + }), + (t.QueryParser.prototype.consumeLexeme = function () { + var e = this.peekLexeme(); + return (this.lexemeIdx += 1), e; + }), + (t.QueryParser.prototype.nextClause = function () { + var e = this.currentClause; + this.query.clause(e), (this.currentClause = {}); + }), + (t.QueryParser.parseClause = function (e) { + var n = e.peekLexeme(); + if (n != null) + switch (n.type) { + case t.QueryLexer.PRESENCE: + return t.QueryParser.parsePresence; + case t.QueryLexer.FIELD: + return t.QueryParser.parseField; + case t.QueryLexer.TERM: + return t.QueryParser.parseTerm; + default: + var r = 'expected either a field or a term, found ' + n.type; + throw ( + (n.str.length >= 1 && (r += " with value '" + n.str + "'"), new t.QueryParseError(r, n.start, n.end)) + ); + } + }), + (t.QueryParser.parsePresence = function (e) { + var n = e.consumeLexeme(); + if (n != null) { + switch (n.str) { + case '-': + e.currentClause.presence = t.Query.presence.PROHIBITED; + break; + case '+': + e.currentClause.presence = t.Query.presence.REQUIRED; + break; + default: + var r = "unrecognised presence operator'" + n.str + "'"; + throw new t.QueryParseError(r, n.start, n.end); + } + var i = e.peekLexeme(); + if (i == null) { + var r = 'expecting term or field, found nothing'; + throw new t.QueryParseError(r, n.start, n.end); + } + switch (i.type) { + case t.QueryLexer.FIELD: + return t.QueryParser.parseField; + case t.QueryLexer.TERM: + return t.QueryParser.parseTerm; + default: + var r = "expecting term or field, found '" + i.type + "'"; + throw new t.QueryParseError(r, i.start, i.end); + } + } + }), + (t.QueryParser.parseField = function (e) { + var n = e.consumeLexeme(); + if (n != null) { + if (e.query.allFields.indexOf(n.str) == -1) { + var r = e.query.allFields + .map(function (o) { + return "'" + o + "'"; + }) + .join(', '), + i = "unrecognised field '" + n.str + "', possible fields: " + r; + throw new t.QueryParseError(i, n.start, n.end); + } + e.currentClause.fields = [n.str]; + var s = e.peekLexeme(); + if (s == null) { + var i = 'expecting term, found nothing'; + throw new t.QueryParseError(i, n.start, n.end); + } + switch (s.type) { + case t.QueryLexer.TERM: + return t.QueryParser.parseTerm; + default: + var i = "expecting term, found '" + s.type + "'"; + throw new t.QueryParseError(i, s.start, s.end); + } + } + }), + (t.QueryParser.parseTerm = function (e) { + var n = e.consumeLexeme(); + if (n != null) { + (e.currentClause.term = n.str.toLowerCase()), + n.str.indexOf('*') != -1 && (e.currentClause.usePipeline = !1); + var r = e.peekLexeme(); + if (r == null) { + e.nextClause(); + return; + } + switch (r.type) { + case t.QueryLexer.TERM: + return e.nextClause(), t.QueryParser.parseTerm; + case t.QueryLexer.FIELD: + return e.nextClause(), t.QueryParser.parseField; + case t.QueryLexer.EDIT_DISTANCE: + return t.QueryParser.parseEditDistance; + case t.QueryLexer.BOOST: + return t.QueryParser.parseBoost; + case t.QueryLexer.PRESENCE: + return e.nextClause(), t.QueryParser.parsePresence; + default: + var i = "Unexpected lexeme type '" + r.type + "'"; + throw new t.QueryParseError(i, r.start, r.end); + } + } + }), + (t.QueryParser.parseEditDistance = function (e) { + var n = e.consumeLexeme(); + if (n != null) { + var r = parseInt(n.str, 10); + if (isNaN(r)) { + var i = 'edit distance must be numeric'; + throw new t.QueryParseError(i, n.start, n.end); + } + e.currentClause.editDistance = r; + var s = e.peekLexeme(); + if (s == null) { + e.nextClause(); + return; + } + switch (s.type) { + case t.QueryLexer.TERM: + return e.nextClause(), t.QueryParser.parseTerm; + case t.QueryLexer.FIELD: + return e.nextClause(), t.QueryParser.parseField; + case t.QueryLexer.EDIT_DISTANCE: + return t.QueryParser.parseEditDistance; + case t.QueryLexer.BOOST: + return t.QueryParser.parseBoost; + case t.QueryLexer.PRESENCE: + return e.nextClause(), t.QueryParser.parsePresence; + default: + var i = "Unexpected lexeme type '" + s.type + "'"; + throw new t.QueryParseError(i, s.start, s.end); + } + } + }), + (t.QueryParser.parseBoost = function (e) { + var n = e.consumeLexeme(); + if (n != null) { + var r = parseInt(n.str, 10); + if (isNaN(r)) { + var i = 'boost must be numeric'; + throw new t.QueryParseError(i, n.start, n.end); + } + e.currentClause.boost = r; + var s = e.peekLexeme(); + if (s == null) { + e.nextClause(); + return; + } + switch (s.type) { + case t.QueryLexer.TERM: + return e.nextClause(), t.QueryParser.parseTerm; + case t.QueryLexer.FIELD: + return e.nextClause(), t.QueryParser.parseField; + case t.QueryLexer.EDIT_DISTANCE: + return t.QueryParser.parseEditDistance; + case t.QueryLexer.BOOST: + return t.QueryParser.parseBoost; + case t.QueryLexer.PRESENCE: + return e.nextClause(), t.QueryParser.parsePresence; + default: + var i = "Unexpected lexeme type '" + s.type + "'"; + throw new t.QueryParseError(i, s.start, s.end); + } + } + }), + (function (e, n) { + typeof define == 'function' && define.amd + ? define(n) + : typeof se == 'object' + ? (oe.exports = n()) + : (e.lunr = n()); + })(this, function () { + return t; + }); + })(); + }); + var re = []; + function G(t, e) { + re.push({selector: e, constructor: t}); + } + var U = class { + constructor() { + this.alwaysVisibleMember = null; + this.createComponents(document.body), + this.ensureActivePageVisible(), + this.ensureFocusedElementVisible(), + this.listenForCodeCopies(), + window.addEventListener('hashchange', () => this.ensureFocusedElementVisible()); + } + createComponents(e) { + re.forEach(n => { + e.querySelectorAll(n.selector).forEach(r => { + r.dataset.hasInstance || (new n.constructor({el: r, app: this}), (r.dataset.hasInstance = String(!0))); + }); + }); + } + filterChanged() { + this.ensureFocusedElementVisible(); + } + ensureActivePageVisible() { + let e = document.querySelector('.tsd-navigation .current'), + n = e?.parentElement; + for (; n && !n.classList.contains('.tsd-navigation'); ) + n instanceof HTMLDetailsElement && (n.open = !0), (n = n.parentElement); + if (e) { + let r = e.getBoundingClientRect().top - document.documentElement.clientHeight / 4; + document.querySelector('.site-menu').scrollTop = r; + } + } + ensureFocusedElementVisible() { + if ( + (this.alwaysVisibleMember && + (this.alwaysVisibleMember.classList.remove('always-visible'), + this.alwaysVisibleMember.firstElementChild.remove(), + (this.alwaysVisibleMember = null)), + !location.hash) + ) + return; + let e = document.getElementById(location.hash.substring(1)); + if (!e) return; + let n = e.parentElement; + for (; n && n.tagName !== 'SECTION'; ) n = n.parentElement; + if (n && n.offsetParent == null) { + (this.alwaysVisibleMember = n), n.classList.add('always-visible'); + let r = document.createElement('p'); + r.classList.add('warning'), + (r.textContent = 'This member is normally hidden due to your filter settings.'), + n.prepend(r); + } + } + listenForCodeCopies() { + document.querySelectorAll('pre > button').forEach(e => { + let n; + e.addEventListener('click', () => { + e.previousElementSibling instanceof HTMLElement && + navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()), + (e.textContent = 'Copied!'), + e.classList.add('visible'), + clearTimeout(n), + (n = setTimeout(() => { + e.classList.remove('visible'), + (n = setTimeout(() => { + e.textContent = 'Copy'; + }, 100)); + }, 1e3)); + }); + }); + } + }; + var ie = (t, e = 100) => { + let n; + return () => { + clearTimeout(n), (n = setTimeout(() => t(), e)); + }; + }; + var de = De(ae()); + async function le(t, e) { + if (!window.searchData) return; + let n = await fetch(window.searchData), + r = new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream('gzip')), + i = await new Response(r).json(); + (t.data = i), (t.index = de.Index.load(i.index)), e.classList.remove('loading'), e.classList.add('ready'); + } + function he() { + let t = document.getElementById('tsd-search'); + if (!t) return; + let e = {base: t.dataset.base + '/'}, + n = document.getElementById('tsd-search-script'); + t.classList.add('loading'), + n && + (n.addEventListener('error', () => { + t.classList.remove('loading'), t.classList.add('failure'); + }), + n.addEventListener('load', () => { + le(e, t); + }), + le(e, t)); + let r = document.querySelector('#tsd-search input'), + i = document.querySelector('#tsd-search .results'); + if (!r || !i) throw new Error('The input field or the result list wrapper was not found'); + let s = !1; + i.addEventListener('mousedown', () => (s = !0)), + i.addEventListener('mouseup', () => { + (s = !1), t.classList.remove('has-focus'); + }), + r.addEventListener('focus', () => t.classList.add('has-focus')), + r.addEventListener('blur', () => { + s || ((s = !1), t.classList.remove('has-focus')); + }), + Ae(t, i, r, e); + } + function Ae(t, e, n, r) { + n.addEventListener( + 'input', + ie(() => { + Ne(t, e, n, r); + }, 200) + ); + let i = !1; + n.addEventListener('keydown', s => { + (i = !0), + s.key == 'Enter' + ? Ve(e, n) + : s.key == 'Escape' + ? n.blur() + : s.key == 'ArrowUp' + ? ue(e, -1) + : s.key === 'ArrowDown' + ? ue(e, 1) + : (i = !1); + }), + n.addEventListener('keypress', s => { + i && s.preventDefault(); + }), + document.body.addEventListener('keydown', s => { + s.altKey || + s.ctrlKey || + s.metaKey || + (!n.matches(':focus') && s.key === '/' && (n.focus(), s.preventDefault())); + }); + } + function Ne(t, e, n, r) { + if (!r.index || !r.data) return; + e.textContent = ''; + let i = n.value.trim(), + s; + if (i) { + let o = i + .split(' ') + .map(a => (a.length ? `*${a}*` : '')) + .join(' '); + s = r.index.search(o); + } else s = []; + for (let o = 0; o < s.length; o++) { + let a = s[o], + l = r.data.rows[Number(a.ref)], + u = 1; + l.name.toLowerCase().startsWith(i.toLowerCase()) && (u *= 1 + 1 / (1 + Math.abs(l.name.length - i.length))), + (a.score *= u); + } + if (s.length === 0) { + let o = document.createElement('li'); + o.classList.add('no-results'); + let a = document.createElement('span'); + (a.textContent = 'No results found'), o.appendChild(a), e.appendChild(o); + } + s.sort((o, a) => a.score - o.score); + for (let o = 0, a = Math.min(10, s.length); o < a; o++) { + let l = r.data.rows[Number(s[o].ref)], + u = ``, + d = ce(l.name, i); + globalThis.DEBUG_SEARCH_WEIGHTS && (d += ` (score: ${s[o].score.toFixed(2)})`), + l.parent && + (d = ` + ${ce(l.parent, i)}.${d}`); + let v = document.createElement('li'); + v.classList.value = l.classes ?? ''; + let f = document.createElement('a'); + (f.href = r.base + l.url), (f.innerHTML = u + d), v.append(f), e.appendChild(v); + } + } + function ue(t, e) { + let n = t.querySelector('.current'); + if (!n) (n = t.querySelector(e == 1 ? 'li:first-child' : 'li:last-child')), n && n.classList.add('current'); + else { + let r = n; + if (e === 1) + do r = r.nextElementSibling ?? void 0; + while (r instanceof HTMLElement && r.offsetParent == null); + else + do r = r.previousElementSibling ?? void 0; + while (r instanceof HTMLElement && r.offsetParent == null); + r && (n.classList.remove('current'), r.classList.add('current')); + } + } + function Ve(t, e) { + let n = t.querySelector('.current'); + if ((n || (n = t.querySelector('li:first-child')), n)) { + let r = n.querySelector('a'); + r && (window.location.href = r.href), e.blur(); + } + } + function ce(t, e) { + if (e === '') return t; + let n = t.toLocaleLowerCase(), + r = e.toLocaleLowerCase(), + i = [], + s = 0, + o = n.indexOf(r); + for (; o != -1; ) + i.push(K(t.substring(s, o)), `${K(t.substring(o, o + r.length))}`), + (s = o + r.length), + (o = n.indexOf(r, s)); + return i.push(K(t.substring(s))), i.join(''); + } + var Be = {'&': '&', '<': '<', '>': '>', "'": ''', '"': '"'}; + function K(t) { + return t.replace(/[&<>"'"]/g, e => Be[e]); + } + var C = class { + constructor(e) { + (this.el = e.el), (this.app = e.app); + } + }; + var F = 'mousedown', + pe = 'mousemove', + B = 'mouseup', + J = {x: 0, y: 0}, + fe = !1, + ee = !1, + He = !1, + D = !1, + me = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent); + document.documentElement.classList.add(me ? 'is-mobile' : 'not-mobile'); + me && + 'ontouchstart' in document.documentElement && + ((He = !0), (F = 'touchstart'), (pe = 'touchmove'), (B = 'touchend')); + document.addEventListener(F, t => { + (ee = !0), (D = !1); + let e = F == 'touchstart' ? t.targetTouches[0] : t; + (J.y = e.pageY || 0), (J.x = e.pageX || 0); + }); + document.addEventListener(pe, t => { + if (ee && !D) { + let e = F == 'touchstart' ? t.targetTouches[0] : t, + n = J.x - (e.pageX || 0), + r = J.y - (e.pageY || 0); + D = Math.sqrt(n * n + r * r) > 10; + } + }); + document.addEventListener(B, () => { + ee = !1; + }); + document.addEventListener('click', t => { + fe && (t.preventDefault(), t.stopImmediatePropagation(), (fe = !1)); + }); + var X = class extends C { + constructor(n) { + super(n); + (this.className = this.el.dataset.toggle || ''), + this.el.addEventListener(B, r => this.onPointerUp(r)), + this.el.addEventListener('click', r => r.preventDefault()), + document.addEventListener(F, r => this.onDocumentPointerDown(r)), + document.addEventListener(B, r => this.onDocumentPointerUp(r)); + } + setActive(n) { + if (this.active == n) return; + (this.active = n), + document.documentElement.classList.toggle('has-' + this.className, n), + this.el.classList.toggle('active', n); + let r = (this.active ? 'to-has-' : 'from-has-') + this.className; + document.documentElement.classList.add(r), setTimeout(() => document.documentElement.classList.remove(r), 500); + } + onPointerUp(n) { + D || (this.setActive(!0), n.preventDefault()); + } + onDocumentPointerDown(n) { + if (this.active) { + if (n.target.closest('.col-sidebar, .tsd-filter-group')) return; + this.setActive(!1); + } + } + onDocumentPointerUp(n) { + if (!D && this.active && n.target.closest('.col-sidebar')) { + let r = n.target.closest('a'); + if (r) { + let i = window.location.href; + i.indexOf('#') != -1 && (i = i.substring(0, i.indexOf('#'))), + r.href.substring(0, i.length) == i && setTimeout(() => this.setActive(!1), 250); + } + } + } + }; + var te; + try { + te = localStorage; + } catch { + te = { + getItem() { + return null; + }, + setItem() {}, + }; + } + var Q = te; + var ve = document.head.appendChild(document.createElement('style')); + ve.dataset.for = 'filters'; + var Y = class extends C { + constructor(n) { + super(n); + (this.key = `filter-${this.el.name}`), + (this.value = this.el.checked), + this.el.addEventListener('change', () => { + this.setLocalStorage(this.el.checked); + }), + this.setLocalStorage(this.fromLocalStorage()), + (ve.innerHTML += `html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`); + } + fromLocalStorage() { + let n = Q.getItem(this.key); + return n ? n === 'true' : this.el.checked; + } + setLocalStorage(n) { + Q.setItem(this.key, n.toString()), (this.value = n), this.handleValueChange(); + } + handleValueChange() { + (this.el.checked = this.value), + document.documentElement.classList.toggle(this.key, this.value), + this.app.filterChanged(), + document.querySelectorAll('.tsd-index-section').forEach(n => { + n.style.display = 'block'; + let r = Array.from(n.querySelectorAll('.tsd-index-link')).every(i => i.offsetParent == null); + n.style.display = r ? 'none' : 'block'; + }); + } + }; + var Z = class extends C { + constructor(n) { + super(n); + (this.summary = this.el.querySelector('.tsd-accordion-summary')), + (this.icon = this.summary.querySelector('svg')), + (this.key = `tsd-accordion-${ + this.summary.dataset.key ?? this.summary.textContent.trim().replace(/\s+/g, '-').toLowerCase() + }`); + let r = Q.getItem(this.key); + (this.el.open = r ? r === 'true' : this.el.open), this.el.addEventListener('toggle', () => this.update()); + let i = this.summary.querySelector('a'); + i && + i.addEventListener('click', () => { + location.assign(i.href); + }), + this.update(); + } + update() { + (this.icon.style.transform = `rotate(${this.el.open ? 0 : -90}deg)`), + Q.setItem(this.key, this.el.open.toString()); + } + }; + function ge(t) { + let e = Q.getItem('tsd-theme') || 'os'; + (t.value = e), + ye(e), + t.addEventListener('change', () => { + Q.setItem('tsd-theme', t.value), ye(t.value); + }); + } + function ye(t) { + document.documentElement.dataset.theme = t; + } + var Le; + function be() { + let t = document.getElementById('tsd-nav-script'); + t && (t.addEventListener('load', xe), xe()); + } + async function xe() { + let t = document.getElementById('tsd-nav-container'); + if (!t || !window.navigationData) return; + let n = await (await fetch(window.navigationData)).arrayBuffer(), + r = new Blob([n]).stream().pipeThrough(new DecompressionStream('gzip')), + i = await new Response(r).json(); + (Le = t.dataset.base + '/'), (t.innerHTML = ''); + for (let s of i) we(s, t, []); + window.app.createComponents(t), window.app.ensureActivePageVisible(); + } + function we(t, e, n) { + let r = e.appendChild(document.createElement('li')); + if (t.children) { + let i = [...n, t.text], + s = r.appendChild(document.createElement('details')); + (s.className = t.class ? `${t.class} tsd-index-accordion` : 'tsd-index-accordion'), (s.dataset.key = i.join('$')); + let o = s.appendChild(document.createElement('summary')); + (o.className = 'tsd-accordion-summary'), + (o.innerHTML = + ''), + Ee(t, o); + let a = s.appendChild(document.createElement('div')); + a.className = 'tsd-accordion-details'; + let l = a.appendChild(document.createElement('ul')); + l.className = 'tsd-nested-navigation'; + for (let u of t.children) we(u, l, i); + } else Ee(t, r, t.class); + } + function Ee(t, e, n) { + if (t.path) { + let r = e.appendChild(document.createElement('a')); + (r.href = Le + t.path), + n && (r.className = n), + location.href === r.href && r.classList.add('current'), + t.kind && + (r.innerHTML = ``), + (r.appendChild(document.createElement('span')).textContent = t.text); + } else e.appendChild(document.createElement('span')).textContent = t.text; + } + G(X, 'a[data-toggle]'); + G(Z, '.tsd-index-accordion'); + G(Y, '.tsd-filter-item input[type=checkbox]'); + var Se = document.getElementById('tsd-theme'); + Se && ge(Se); + var je = new U(); + Object.defineProperty(window, 'app', {value: je}); + he(); + be(); +})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 01927c3a..0e722317 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1,2 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA4uuVipJrShRslLyrXTOSSwuVtJRKkgsyQAKJIO4qcX6UAm9jJLcHKBsdmZeipKVoZFFbSwAMUbVPD0AAAA=" \ No newline at end of file +window.navigationData = + 'data:application/octet-stream;base64,H4sIAAAAAAAAA4uuVipJrShRslLyrXTOSSwuVtJRKkgsyQAKJIO4qcX6UAm9jJLcHKBsdmZeipKVoZFFbSwAMUbVPD0AAAA='; diff --git a/docs/assets/search.js b/docs/assets/search.js index 460ac1e8..dcd884c5 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1,2 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA4WSTU+EMBCG/8t4bdi2asJy9bIevHppiCFQs8TSkraoG8J/d0rBLgmuF5KZed53PsoI1nw5KMQIH61uoGA8J6CrTkIBL5cnVTkHBAarMK5DJN1hyWdn3yksLmkEYCKrzyPjvz610c7bofbG3vS624JXvgT6ykrtr4ZKrTh9SDNb6QerT1Ipc7vXFvynV0kAW8lvKEb4lNa1RmOZZ/fZEfn3VqomHDEOgW6m64JDudReZVgpEBE5UCCCkmOW07wsiVgFc35OzBTDiO1QbENxjPgOxWdqnhxH9rJ5jhsIsX2QEd6W3dh6xREYfqYpbRKiYN5d6vhLJBVNKvqHKt76HG+dlDwp+Z4SZ+/bXqpWIyPKafoBlJktyq4CAAA="; \ No newline at end of file +window.searchData = + 'data:application/octet-stream;base64,H4sIAAAAAAAAA4WSTU+EMBCG/8t4bdi2asJy9bIevHppiCFQs8TSkraoG8J/d0rBLgmuF5KZed53PsoI1nw5KMQIH61uoGA8J6CrTkIBL5cnVTkHBAarMK5DJN1hyWdn3yksLmkEYCKrzyPjvz610c7bofbG3vS624JXvgT6ykrtr4ZKrTh9SDNb6QerT1Ipc7vXFvynV0kAW8lvKEb4lNa1RmOZZ/fZEfn3VqomHDEOgW6m64JDudReZVgpEBE5UCCCkmOW07wsiVgFc35OzBTDiO1QbENxjPgOxWdqnhxH9rJ5jhsIsX2QEd6W3dh6xREYfqYpbRKiYN5d6vhLJBVNKvqHKt76HG+dlDwp+Z4SZ+/bXqpWIyPKafoBlJktyq4CAAA='; diff --git a/docs/assets/style.css b/docs/assets/style.css index 108428c3..9df2ba1d 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -1,174 +1,85 @@ :root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --light-color-icon-background: var(--light-color-background); - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); - --light-color-text: #222; - --light-color-text-aside: #6e6e6e; - --light-color-link: #1f70c2; - - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: var(--light-color-ts-variable); - --light-color-ts-method: var(--light-color-ts-function); - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: var(--light-color-ts-type-alias); - --light-color-ts-accessor: var(--light-color-ts-property); - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; - --dark-color-text: #f5f5f5; - --dark-color-text-aside: #dddddd; - --dark-color-link: #00aff4; - - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: var(--dark-color-ts-variable); - --dark-color-ts-method: var(--dark-color-ts-function); - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); - --dark-color-ts-accessor: var(--dark-color-ts-property); - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: var(--light-color-ts-type-alias); + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; } @media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); - } -} - -html { - color-scheme: var(--color-scheme); -} - -body { - margin: 0; -} - -:root[data-theme="light"] { + :root { --color-background: var(--light-color-background); --color-background-secondary: var(--light-color-background-secondary); --color-background-warning: var(--light-color-background-warning); @@ -193,9 +104,7 @@ body { --color-ts-method: var(--light-color-ts-method); --color-ts-call-signature: var(--light-color-ts-call-signature); --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); + --color-ts-constructor-signature: var(--light-color-ts-constructor-signature); --color-ts-parameter: var(--light-color-ts-parameter); --color-ts-type-parameter: var(--light-color-ts-type-parameter); --color-ts-accessor: var(--light-color-ts-accessor); @@ -205,9 +114,11 @@ body { --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); + } } -:root[data-theme="dark"] { +@media (prefers-color-scheme: dark) { + :root { --color-background: var(--dark-color-background); --color-background-secondary: var(--dark-color-background-secondary); --color-background-warning: var(--dark-color-background-warning); @@ -232,9 +143,7 @@ body { --color-ts-method: var(--dark-color-ts-method); --color-ts-call-signature: var(--dark-color-ts-call-signature); --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); + --color-ts-constructor-signature: var(--dark-color-ts-constructor-signature); --color-ts-parameter: var(--dark-color-ts-parameter); --color-ts-type-parameter: var(--dark-color-ts-type-parameter); --color-ts-accessor: var(--dark-color-ts-accessor); @@ -244,11 +153,94 @@ body { --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme='light'] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var(--light-color-ts-constructor-signature); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme='dark'] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var(--dark-color-ts-constructor-signature); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); } .always-visible, .always-visible .tsd-signatures { - display: inherit !important; + display: inherit !important; } h1, @@ -257,7 +249,7 @@ h3, h4, h5, h6 { - line-height: 1.2; + line-height: 1.2; } h1 > a, @@ -266,1118 +258,1118 @@ h3 > a, h4 > a, h5 > a, h6 > a { - text-decoration: none; - color: var(--color-text); + text-decoration: none; + color: var(--color-text); } h1 { - font-size: 1.875rem; - margin: 0.67rem 0; + font-size: 1.875rem; + margin: 0.67rem 0; } h2 { - font-size: 1.5rem; - margin: 0.83rem 0; + font-size: 1.5rem; + margin: 0.83rem 0; } h3 { - font-size: 1.25rem; - margin: 1rem 0; + font-size: 1.25rem; + margin: 1rem 0; } h4 { - font-size: 1.05rem; - margin: 1.33rem 0; + font-size: 1.05rem; + margin: 1.33rem 0; } h5 { - font-size: 1rem; - margin: 1.5rem 0; + font-size: 1rem; + margin: 1.5rem 0; } h6 { - font-size: 0.875rem; - margin: 2.33rem 0; + font-size: 0.875rem; + margin: 2.33rem 0; } .uppercase { - text-transform: uppercase; + text-transform: uppercase; } dl, menu, ol, ul { - margin: 1em 0; + margin: 1em 0; } dd { - margin: 0 0 0 40px; + margin: 0 0 0 40px; } .container { - max-width: 1700px; - padding: 0 2rem; + max-width: 1700px; + padding: 0 2rem; } /* Footer */ .tsd-generator { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; } .tsd-generator > p { - margin-top: 0; - margin-bottom: 0; - padding: 0 1rem; + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; } .container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); } @keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } + from { + opacity: 0; + } + to { + opacity: 1; + } } @keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } } @keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } } @keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } } @keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } } @keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } } body { - background: var(--color-background); - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: var(--color-text); + background: var(--color-background); + font-family: 'Segoe UI', sans-serif; + font-size: 16px; + color: var(--color-text); } a { - color: var(--color-link); - text-decoration: none; + color: var(--color-link); + text-decoration: none; } a:hover { - text-decoration: underline; + text-decoration: underline; } -a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; +a.external[target='_blank'] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; } code, pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; + font-family: Menlo, Monaco, Consolas, 'Courier New', monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; } pre { - position: relative; - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); } pre code { - padding: 0; - font-size: 100%; + padding: 0; + font-size: 100%; } pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; } pre:hover > button, pre > button.visible { - opacity: 1; + opacity: 1; } blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; } .tsd-typography { - line-height: 1.333em; + line-height: 1.333em; } .tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; + list-style: square; + padding: 0 0 0 20px; + margin: 0; } .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h4, .tsd-typography h5, .tsd-typography h6 { - font-size: 1em; + font-size: 1em; } .tsd-typography h5, .tsd-typography h6 { - font-weight: normal; + font-weight: normal; } .tsd-typography p, .tsd-typography ul, .tsd-typography ol { - margin: 1em 0; + margin: 1em 0; } .tsd-typography table { - border-collapse: collapse; - border: none; + border-collapse: collapse; + border: none; } .tsd-typography td, .tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); + padding: 6px 13px; + border: 1px solid var(--color-accent); } .tsd-typography thead, .tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); + background-color: var(--color-background-secondary); } .tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); + margin: 0; + padding: 0; + color: var(--color-text-aside); } .tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; + color: var(--color-text-aside); + text-decoration: none; } .tsd-breadcrumb a:hover { - text-decoration: underline; + text-decoration: underline; } .tsd-breadcrumb li { - display: inline; + display: inline; } .tsd-breadcrumb li:after { - content: " / "; + content: ' / '; } .tsd-comment-tags { - display: flex; - flex-direction: column; + display: flex; + flex-direction: column; } dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; } dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; } dl.tsd-comment-tag-group dd { - margin: 0; + margin: 0; } code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; } h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; + margin-left: 0.25em; } dl.tsd-comment-tag-group dd:before, dl.tsd-comment-tag-group dd:after { - content: " "; + content: ' '; } dl.tsd-comment-tag-group dd pre, dl.tsd-comment-tag-group dd:after { - clear: both; + clear: both; } dl.tsd-comment-tag-group p { - margin: 0; + margin: 0; } .tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; } .tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; + margin-bottom: 0; } .tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; } .tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; + margin-bottom: 0.5rem; } .tsd-filter-input { - display: flex; - width: fit-content; - width: -moz-fit-content; - align-items: center; - user-select: none; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - cursor: pointer; -} -.tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; -} -.tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type='checkbox'] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type='checkbox']:disabled { + pointer-events: none; } .tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. Don't remove unless you know what you're doing. */ - opacity: 0.99; + opacity: 0.99; } -.tsd-filter-input input[type="checkbox"]:focus + svg { - transform: scale(0.95); +.tsd-filter-input input[type='checkbox']:focus + svg { + transform: scale(0.95); } -.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { - transform: scale(1); +.tsd-filter-input input[type='checkbox']:focus:not(:focus-visible) + svg { + transform: scale(1); } .tsd-checkbox-background { - fill: var(--color-accent); + fill: var(--color-accent); } -input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); +input[type='checkbox']:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); } .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; } .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); + stroke: var(--color-accent); } .tsd-theme-toggle { - padding-top: 0.75rem; + padding-top: 0.75rem; } .tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; + display: inline; + vertical-align: middle; + margin-right: 0.75rem; } .tsd-hierarchy { - list-style: square; - margin: 0; + list-style: square; + margin: 0; } .tsd-hierarchy .target { - font-weight: bold; + font-weight: bold; } .tsd-panel-group.tsd-index-group { - margin-bottom: 0; + margin-bottom: 0; } .tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; } @media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); - } + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } } @media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); - } + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } } .tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; } .tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; } .tsd-anchor { - position: relative; - top: -100px; + position: relative; + top: -100px; } .tsd-member { - position: relative; + position: relative; } .tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; } .tsd-navigation.settings { - margin: 1rem 0; + margin: 1rem 0; } .tsd-navigation > a, .tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.5rem); + width: calc(100% - 0.5rem); } .tsd-navigation a, .tsd-navigation summary > span, .tsd-page-navigation a { - display: inline-flex; - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; + display: inline-flex; + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; } .tsd-navigation a.current, .tsd-page-navigation a.current { - background: var(--color-active-menu-item); + background: var(--color-active-menu-item); } .tsd-navigation a:hover, .tsd-page-navigation a:hover { - text-decoration: underline; + text-decoration: underline; } .tsd-navigation ul, .tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; } .tsd-navigation li, .tsd-page-navigation li { - padding: 0; - max-width: 100%; + padding: 0; + max-width: 100%; } .tsd-nested-navigation { - margin-left: 3rem; + margin-left: 3rem; } .tsd-nested-navigation > li > details { - margin-left: -1.5rem; + margin-left: -1.5rem; } .tsd-small-nested-navigation { - margin-left: 1.5rem; + margin-left: 1.5rem; } .tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; + margin-left: -1.5rem; } .tsd-nested-navigation > li > a, .tsd-nested-navigation > li > span { - width: calc(100% - 1.75rem - 0.5rem); + width: calc(100% - 1.75rem - 0.5rem); } .tsd-page-navigation ul { - padding-left: 1.75rem; + padding-left: 1.75rem; } #tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; } #tsd-sidebar-links a:last-of-type { - margin-bottom: 0; + margin-bottom: 0; } a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); } .tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ } .tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ + display: none; /* hide marker on safari */ } .tsd-accordion-summary, .tsd-accordion-summary a { - user-select: none; - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; - cursor: pointer; + cursor: pointer; } .tsd-accordion-summary a { - width: calc(100% - 1.5rem); + width: calc(100% - 1.5rem); } .tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; } .tsd-index-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; + margin-left: 0.25rem; } .tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; + margin-top: 0.75rem; } .tsd-index-heading { - margin-top: 1.5rem; - margin-bottom: 0.75rem; + margin-top: 1.5rem; + margin-bottom: 0.75rem; } .tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; } .tsd-kind-icon path { - transform-origin: center; - transform: scale(1.1); + transform-origin: center; + transform: scale(1.1); } .tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; + margin-right: 0.8rem; } .tsd-panel { - margin-bottom: 2.5rem; + margin-bottom: 2.5rem; } .tsd-panel.tsd-member { - margin-bottom: 4rem; + margin-bottom: 4rem; } .tsd-panel:empty { - display: none; + display: none; } .tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; } .tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; + margin-bottom: 0; + border-bottom: none; } .tsd-panel-group { - margin: 4rem 0; + margin: 4rem 0; } .tsd-panel-group.tsd-index-group { - margin: 2rem 0; + margin: 2rem 0; } .tsd-panel-group.tsd-index-group details { - margin: 2rem 0; + margin: 2rem 0; } #tsd-search { - transition: background-color 0.2s; + transition: background-color 0.2s; } #tsd-search .title { - position: relative; - z-index: 2; + position: relative; + z-index: 2; } #tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; } #tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); } #tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; + position: absolute; + overflow: hidden; + right: -40px; } #tsd-search .field input, #tsd-search .title, #tsd-toolbar-links a { - transition: opacity 0.2s; + transition: opacity 0.2s; } #tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } #tsd-search .results li { - background-color: var(--color-background); - line-height: initial; - padding: 4px; + background-color: var(--color-background); + line-height: initial; + padding: 4px; } #tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); + background-color: var(--color-background-secondary); } #tsd-search .results li.state { - display: none; + display: none; } #tsd-search .results li.current:not(.no-results), #tsd-search .results li:hover:not(.no-results) { - background-color: var(--color-accent); + background-color: var(--color-accent); } #tsd-search .results a { - display: flex; - align-items: center; - padding: 0.25rem; - box-sizing: border-box; + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; } #tsd-search .results a:before { - top: 10px; + top: 10px; } #tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; + color: var(--color-text-aside); + font-weight: normal; } #tsd-search.has-focus { - background-color: var(--color-accent); + background-color: var(--color-accent); } #tsd-search.has-focus .field input { - top: 0; - opacity: 1; + top: 0; + opacity: 1; } #tsd-search.has-focus .title, #tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; + z-index: 0; + opacity: 0; } #tsd-search.has-focus .results { - visibility: visible; + visibility: visible; } #tsd-search.loading .results li.state.loading { - display: block; + display: block; } #tsd-search.failure .results li.state.failure { - display: block; + display: block; } #tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; } #tsd-toolbar-links a { - margin-left: 1.5rem; + margin-left: 1.5rem; } #tsd-toolbar-links a:hover { - text-decoration: underline; + text-decoration: underline; } .tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, 'Courier New', monospace; + font-size: 14px; + overflow-x: auto; } .tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; + color: var(--color-text-aside); + font-weight: normal; } .tsd-signature-type { - font-style: italic; - font-weight: normal; + font-style: italic; + font-weight: normal; } .tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; } .tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; } .tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; + border-width: 1px; } ul.tsd-parameter-list, ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; + list-style: square; + margin: 0; + padding-left: 20px; } ul.tsd-parameter-list > li.tsd-parameter-signature, ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; + list-style: none; + margin-left: -20px; } ul.tsd-parameter-list h5, ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; + font-size: 16px; + margin: 1em 0 0.5em 0; } .tsd-sources { - margin-top: 1rem; - font-size: 0.875em; + margin-top: 1rem; + font-size: 0.875em; } .tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; + color: var(--color-text-aside); + text-decoration: underline; } .tsd-sources ul { - list-style: none; - padding: 0; + list-style: none; + padding: 0; } .tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; } .tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; + color: var(--color-text); + text-decoration: none; } .tsd-page-toolbar a.title { - font-weight: bold; + font-weight: bold; } .tsd-page-toolbar a.title:hover { - text-decoration: underline; + text-decoration: underline; } .tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; } .tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; + position: relative; + white-space: nowrap; + line-height: 40px; } .tsd-page-toolbar .table-cell:first-child { - width: 100%; + width: 100%; } .tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; + box-sizing: border-box; + line-height: 0; + padding: 12px 0; } .tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: - opacity 0.1s, - background-color 0.2s; - vertical-align: bottom; - cursor: pointer; + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; } .tsd-widget:hover { - opacity: 0.9; + opacity: 0.9; } .tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); + opacity: 1; + background-color: var(--color-accent); } .tsd-widget.no-caption { - width: 40px; + width: 40px; } .tsd-widget.no-caption:before { - margin: 0; + margin: 0; } .tsd-widget.options, .tsd-widget.menu { - display: none; + display: none; } -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; +input[type='checkbox'] + .tsd-widget:before { + background-position: -120px 0; } -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; +input[type='checkbox']:checked + .tsd-widget:before { + background-position: -160px 0; } img { - max-width: 100%; + max-width: 100%; } .tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); } .tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; + width: 1em; + height: 1em; + visibility: hidden; } .tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; + visibility: visible; } .deprecated { - text-decoration: line-through !important; + text-decoration: line-through !important; } .warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); } .tsd-kind-project { - color: var(--color-ts-project); + color: var(--color-ts-project); } .tsd-kind-module { - color: var(--color-ts-module); + color: var(--color-ts-module); } .tsd-kind-namespace { - color: var(--color-ts-namespace); + color: var(--color-ts-namespace); } .tsd-kind-enum { - color: var(--color-ts-enum); + color: var(--color-ts-enum); } .tsd-kind-enum-member { - color: var(--color-ts-enum-member); + color: var(--color-ts-enum-member); } .tsd-kind-variable { - color: var(--color-ts-variable); + color: var(--color-ts-variable); } .tsd-kind-function { - color: var(--color-ts-function); + color: var(--color-ts-function); } .tsd-kind-class { - color: var(--color-ts-class); + color: var(--color-ts-class); } .tsd-kind-interface { - color: var(--color-ts-interface); + color: var(--color-ts-interface); } .tsd-kind-constructor { - color: var(--color-ts-constructor); + color: var(--color-ts-constructor); } .tsd-kind-property { - color: var(--color-ts-property); + color: var(--color-ts-property); } .tsd-kind-method { - color: var(--color-ts-method); + color: var(--color-ts-method); } .tsd-kind-call-signature { - color: var(--color-ts-call-signature); + color: var(--color-ts-call-signature); } .tsd-kind-index-signature { - color: var(--color-ts-index-signature); + color: var(--color-ts-index-signature); } .tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); + color: var(--color-ts-constructor-signature); } .tsd-kind-parameter { - color: var(--color-ts-parameter); + color: var(--color-ts-parameter); } .tsd-kind-type-literal { - color: var(--color-ts-type-literal); + color: var(--color-ts-type-literal); } .tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); + color: var(--color-ts-type-parameter); } .tsd-kind-accessor { - color: var(--color-ts-accessor); + color: var(--color-ts-accessor); } .tsd-kind-get-signature { - color: var(--color-ts-get-signature); + color: var(--color-ts-get-signature); } .tsd-kind-set-signature { - color: var(--color-ts-set-signature); + color: var(--color-ts-set-signature); } .tsd-kind-type-alias { - color: var(--color-ts-type-alias); + color: var(--color-ts-type-alias); } /* if we have a kind icon, don't color the text by kind */ .tsd-kind-icon ~ span { - color: var(--color-text); + color: var(--color-text); } * { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); } *::-webkit-scrollbar { - width: 0.75rem; + width: 0.75rem; } *::-webkit-scrollbar-track { - background: var(--color-icon-background); + background: var(--color-icon-background); } *::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); } /* mobile */ @media (max-width: 769px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } - - .container-main { - display: flex; - } - html .col-content { - float: none; - max-width: 100%; - width: 100%; - } - html .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-sidebar > *:last-child { - padding-bottom: 20px; - } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ''; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } } /* one sidebar */ @media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - margin: 2rem auto; - } - - .col-sidebar { - grid-area: sidebar; - } - .col-content { - grid-area: content; - padding: 0 1rem; - } + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: 'sidebar content'; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } } @media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; - } - .site-menu { - margin-top: 1rem; - } + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } } /* two sidebars */ @media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: "sidebar content toc"; - } - - .col-sidebar { - display: contents; - } - - .page-menu { - grid-area: toc; - padding-left: 1rem; - } - .site-menu { - grid-area: sidebar; - } - - .site-menu { - margin-top: 1rem 0; - } - - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - } + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: 'sidebar content toc'; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } } diff --git a/docs/classes/MyClass.html b/docs/classes/MyClass.html index d6c1118d..6c9e4e1b 100644 --- a/docs/classes/MyClass.html +++ b/docs/classes/MyClass.html @@ -1,3 +1,963 @@ -MyClass | @bennycode/ts-node-starter

Class MyClass

Hierarchy

  • MyClass

Constructors

constructor -

Methods

returnHello -

Constructors

constructor

Methods

returnHello

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file + + + + + + MyClass | @bennycode/ts-node-starter + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class MyClass

+
+
+

Hierarchy

+
    +
  • MyClass
    • +
+
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Methods

+
+ + returnHello +
+
+
+
+
+
+
+

Constructors

+
+ +

+ constructor +

+ +
+
+
+

Methods

+
+ +

+ returnHello +

+
    + +
  • +

    Returns string

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

+ + Settings +

+ +
+
+

Member Visibility

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

Theme

+ +
+
+
+
+
+ +

+ + On This Page +

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

+ Generated using + TypeDoc +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/index.html b/docs/index.html index 1d810aa5..21a16f6f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,71 +1,1134 @@ -@bennycode/ts-node-starter

@bennycode/ts-node-starter

ts-node-starter

The ts-node-starter scaffolding project is a template repository which makes it easy for you to start a new Node.js project with TypeScript.

-

Using this template, you can build standalone apps, libraries and/or CLI tools. The ts-node-starter setup is configurable and comes with a lot of features included.

-

Features

    -
  1. Changelog generation powered by generate-changelog
    2. -
  2. Automatic code & config formatting powered by Lefthook
    3. -
  3. Automatic dependency updates powered by Dependabot
    4. -
  4. Config formatting powered by Prettier
    5. -
  5. Code linting powered by ESLint
    6. -
  6. Continuous integration powered by GitHub Actions workflows
    7. -
  7. Dependency management powered by npm
    8. -
  8. Unit testing powered by Vitest
    9. -
  9. Code coverage powered by v8
    10. -
  10. Code coverage reports powered by Codecov
    11. -
  11. Type checking powered by TypeScript
    12. -
  12. Streamlined scripts powered by Conventional Scripts
    13. -
-

Usage

Make it your own

    -
  1. Replace all occurrences of "bennycode" with your own username (or organization name)
    2. -
  2. Replace all occurrences of "ts-node-starter" with your project name (or repository name)
    3. -
  3. Start writing your code in the "src" directory
    4. -
  4. Run npm install and be happy! 😊
    5. -
-

Build a standalone app

Source Code

-

If you just want to write and run a Node.js app, checkout "src/start.ts".

-

References

-

You can start your application by executing yarn start. If you want to debug your code, run yarn debug (Debug Instructions).

-

Build a Library

Source Code

-

If you want to distribute your code as a Node.js library on npm, you can have a look at "src/index.ts". If you build a library, I recommend to always ship an index file from where you export the code of your library for others.

-

References

-

In the "package.json" file you will also discover a "main" property which defines the entry point to your library when it gets imported by other developers. The value of the "main" property has to point to the transpiled JavaScript code.

-

Build a CLI

Source Code

-

If you want to build a CLI tool for Node.js, you can have a look at "src/cli.ts".

-

References

-

In the "package.json" file you will also discover a "bin" property which defines the executable name of your tool and the entry point to its transpiled JavaScript code.

-

If you don't want to publish a CLI, simply remove the "bin" property and the CLI script.

-

Conventions

Test Files

I recommend to colocate your test code with your source code by naming your test files *.test.ts.

-

Changelog Generation

The automatic changelog generation is based on Semantic Commit Messages. Simply use the suggested prefixes in your commit messages to make use of it. For example, if you commit a new feature use the "feat" prefix:

-

Commit Message:

-
-

feat: My new feature

-
-

If you are introducing a breaking change, add an exclamation mark (!) after the type or scope of your commit message:

-

Example:

-
-

refactoring!: Make file handlers asynchronous

-
-

This is as per breaking change definition of Conventional Commits 1.0.0.

-

Troubleshooting

If you're having trouble with the Git pre-commit hook, then reinstall the hook using the following command:

-
npx lefthook install -a
+
+
+  
+    
+    
+    @bennycode/ts-node-starter
+    
+    
+    
+    
+    
+    
+    
+  
+  
+    
+    

+      

+        
+        

+          
+              
+        

+      

+    

+    

+      

+        
@bennycode/ts-node-starter

+        

+          
+          
ts-node-starter

+          

+            The ts-node-starter scaffolding project is a
+            template repository
+            which makes it easy for you to start a new Node.js project with TypeScript.
+          

+          

+            Using this template, you can build standalone apps, libraries and/or
+            CLI tools. The ts-node-starter setup is configurable and comes with a lot of
+            features included.
+          

+          
+          
Features

+          
    
+            
  1. 
+              Changelog generation powered by
+              generate-changelog
+            
    2. 
+            
  2. 
+              Automatic code & config formatting powered by
+              Lefthook
+            
    3. 
+            
  3. 
+              Automatic dependency updates powered by
+              Dependabot
+            
    4. 
+            
  4. Config formatting powered by Prettier
    5. 
+            
  5. Code linting powered by ESLint
    6. 
+            
  6. 
+              Continuous integration powered by
+              GitHub Actions workflows
+            
    7. 
+            
  7. Dependency management powered by npm
    8. 
+            
  8. Unit testing powered by Vitest
    9. 
+            
  9. 
+              Code coverage powered by v8
+            
    10. 
+            
  10. Code coverage reports powered by Codecov
    11. 
+            
  11. Type checking powered by TypeScript
    12. 
+            
  12. 
+              Streamlined scripts powered by
+              Conventional Scripts
+            
    13. 
+          

+          
+          
Usage

+          
+          
Make it your own

+          
    
+            
  1. Replace all occurrences of "bennycode" with your own username (or organization name)
    2. 
+            
  2. Replace all occurrences of "ts-node-starter" with your project name (or repository name)
    3. 
+            
  3. Start writing your code in the "src" directory
    4. 
+            
  4. Run npm install and be happy! 😊
    5. 
+          

+          
+          
Build a standalone app

+          
Source Code

+          

+            If you just want to write and run a Node.js app, checkout
+            "src/start.ts".
+          

+          
References

+          

+            You can start your application by executing yarn start. If you want to debug your code, run
+            yarn debug (Debug Instructions).
+          

+          
+          
Build a Library

+          
Source Code

+          

+            If you want to distribute your code as a Node.js library on npm, you
+            can have a look at "src/index.ts". If you build a library, I
+            recommend to always ship an index file from where you export the code of your library for others.
+          

+          
References

+          

+            In the "package.json" file you will also discover a "main"
+            property which defines the entry point to your library when it gets imported by other developers. The value
+            of the "main" property has to point to the transpiled JavaScript code.
+          

+          
+          
Build a CLI

+          
Source Code

+          

+            If you want to build a CLI tool for Node.js, you can have a look at
+            "src/cli.ts".
+          

+          
References

+          

+            In the "package.json" file you will also discover a "bin"
+            property which defines the executable name of your tool and the entry point to its transpiled JavaScript
+            code.
+          

+          
If you don't want to publish a CLI, simply remove the "bin" property and the CLI script.

+          
+          
Conventions

+          
+          
Test Files

+          

+            I recommend to colocate your test code with your source code by naming your test files
+            *.test.ts.
+          

+          
+          
Changelog Generation

+          

+            The automatic changelog generation is based on
+            Semantic Commit Messages. Simply use the
+            suggested prefixes in your commit messages to make use of it. For example, if you commit a new feature use
+            the "feat" prefix:
+          

+          
Commit Message:

+          

+            
feat: My new feature

+          

+          

+            If you are introducing a breaking change, add an exclamation mark (!) after the type or scope
+            of your commit message:
+          

+          
Example:

+          

+            
refactoring!: Make file handlers asynchronous

+          

+          

+            This is as per
+            breaking change definition
+            of Conventional Commits 1.0.0.
+          

+          
+          
Troubleshooting

+          

+            If you're having trouble with the Git pre-commit hook, then reinstall the hook using the following
+            command:
+          

+          
npx lefthook install -a
 

-
Source: Hooks don't run

-
Inspiring Templates
Other inspiring Node.js templates:

-
-
Important Refactorings
    
-
  1. Replaced EditorConfig with Prettier (2e24f7b)
    2. 
-
  2. Replaced Jasmine with Jest (41e9b42)
    3. 
-
  3. Replaced action-dependabot-auto-merge with Dependabot & GitHub CLI (86d5696)
    4. 
-
  4. Replaced husky with Lefthook (9c41615)
    5. 
-
  5. Replaced custom ESLint Config with a Shareable Config (eef5927)
    6. 
-
  6. Replaced @types/jest with @jest/globals (73c5bc2)
    7. 
-
  7. Replaced Yarn 1 with npm (153b726)
    8. 
-
  8. Replaced pretty-quick with Prettier 3 (7623ba8)
    9. 
-
  9. Replaced Jest with Vitest (662dddf)
    10. 
-
  10. Replaced CommonJS with EcmaScript Modules (0cae631)
    11. 
-
  11. Replaced imports with Vitest Globals (6b273c3)
    12. 
-

-
Contributors
Benny Neugebauer on Stack Exchange

-
Panayiotis Lipiridis on Stack Exchange

-
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc

\ No newline at end of file
+          
Source: Hooks don't run

+          
+          
Inspiring Templates

+          
Other inspiring Node.js templates:

+          
+          
+          
Important Refactorings

+          
    
+            
  1. 
+              Replaced EditorConfig with
+              Prettier (2e24f7b)
+            
    2. 
+            
  2. 
+              Replaced Jasmine with Jest (41e9b42)
+            
    3. 
+            
  3. 
+              Replaced
+              action-dependabot-auto-merge
+              with Dependabot &
+              GitHub CLI (86d5696)
+            
    4. 
+            
  4. 
+              Replaced husky with
+              Lefthook (9c41615)
+            
    5. 
+            
  5. 
+              Replaced custom ESLint Config with a
+              Shareable Config (eef5927)
+            
    6. 
+            
  6. 
+              Replaced @types/jest with
+              @jest/globals (73c5bc2)
+            
    7. 
+            
  7. 
+              Replaced Yarn 1 with
+              npm (153b726)
+            
    8. 
+            
  8. 
+              Replaced pretty-quick with
+              Prettier 3 (7623ba8)
+            
    9. 
+            
  9. 
+              Replaced Jest with Vitest (662dddf)
+            
    10. 
+            
  10. 
+              Replaced CommonJS with
+              EcmaScript Modules (0cae631)
+            
    11. 
+            
  11. 
+              Replaced imports with Vitest Globals (6b273c3)
+            
    12. 
+          

+          
+          
Contributors

+          

+            Benny Neugebauer on Stack Exchange
+          

+          

+            Panayiotis Lipiridis on Stack Exchange
+          

+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

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

Theme

+ +
+
+
+
+
+ +

+ + On This Page +

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

+ Generated using + TypeDoc +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/modules.html b/docs/modules.html index d3d76f2d..43a8b9cf 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,2 +1,764 @@ -@bennycode/ts-node-starter

@bennycode/ts-node-starter

Index

Classes

MyClass -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + @bennycode/ts-node-starter + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+

@bennycode/ts-node-starter

+
+
+

Index

+
+

Classes

+
+ + MyClass +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

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

Theme

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

+ Generated using + TypeDoc +

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