[ { "path": ".commitlintrc.json", "content": "{\n \"extends\": [\"@commitlint/config-conventional\"]\n}" }, { "path": ".eslintrc.json", "content": "{ // https://github.com/Microsoft/vscode-eslint/issues/284\n \"parser\": \"@typescript-eslint/parser\",\n \"extends\": [\"eslint:recommended\"],\n \"plugins\": [\"react\", \"fp\"],\n \"env\": {\n \"browser\": true,\n \"es6\": true,\n \"commonjs\": true\n },\n \"globals\": {\n \"__dirname\": false\n },\n \"parserOptions\": {\n \"jsx\": true,\n \"ecmaFeatures\": {\n \"jsx\": true\n },\n \"ecmaVersion\": 2018,\n \"sourceType\": \"module\"\n },\n \"rules\": {\n // code features\n \"array-callback-return\" : [\"error\"],\n \"arrow-parens\" : [\"error\"],\n \"arrow-spacing\" : [\"error\"],\n \"curly\" : [\"error\", \"multi-or-nest\"],\n \"default-case\" : [\"error\"],\n \"dot-location\" : [\"error\"],\n \"eqeqeq\" : [\"warn\"],\n \"generator-star-spacing\" : [\"error\"],\n \"no-caller\" : [\"error\"],\n \"no-console\" : [\"off\"],\n \"no-div-regex\" : [\"error\"],\n \"no-else-return\" : [\"error\"],\n \"no-extend-native\" : [\"error\"],\n \"no-floating-decimal\" : [\"error\"],\n // \"no-implicit-coercion\" : [\"error\"],\n \"no-implicit-globals\" : [\"error\"],\n \"no-implied-eval\" : [\"error\"],\n \"no-invalid-this\" : [\"error\"],\n \"no-labels\" : [\"error\"],\n \"no-new-wrappers\" : [\"error\"],\n \"no-proto\" : [\"error\"],\n \"no-return-assign\" : [\"error\"],\n \"no-return-await\" : [\"error\"],\n \"no-self-compare\" : [\"error\"],\n \"no-sequences\" : [\"error\"],\n \"no-unmodified-loop-condition\": [\"warn\"],\n \"no-undef\" : [\"off\"],\n \"no-unused-vars\" : [\"off\"],\n \"no-useless-call\" : [\"error\"],\n \"no-useless-catch\" : [\"error\"],\n \"no-useless-concat\" : [\"error\"],\n \"no-useless-return\" : [\"error\"],\n \"no-var\" : [\"error\"],\n \"no-with\" : [\"error\"],\n // \"object-shorthand\" : [\"warn\"],\n \"prefer-arrow-callback\" : [\"error\"],\n \"prefer-rest-params\" : [\"error\"],\n \"prefer-spread\" : [\"error\"],\n \"prefer-template\" : [\"error\"],\n \"require-await\" : [\"warn\"],\n \"require-unicode-regexp\" : [\"error\"],\n \"rest-spread-spacing\" : [\"error\"],\n \"symbol-description\" : [\"error\"],\n \"template-curly-spacing\" : [\"error\"],\n \"yield-star-spacing\" : [\"error\", \"before\"],\n \"yoda\" : [\"error\"],\n // code style\n \"array-bracket-newline\" : [\"error\", \"consistent\"],\n \"array-bracket-spacing\" : [\"error\"],\n \"block-spacing\" : [\"error\", \"never\"],\n \"brace-style\" : [\"error\", \"1tbs\", {\"allowSingleLine\": true}],\n \"comma-dangle\" : [\"error\", \"always-multiline\"],\n \"comma-spacing\" : [\"error\", {\"before\": false, \"after\": true}],\n \"computed-property-spacing\" : [\"error\"],\n \"eol-last\" : [\"error\"],\n \"func-call-spacing\" : [\"error\"],\n \"indent\" : [\"error\", 4, {\"MemberExpression\": 0}],\n \"key-spacing\" : [\"error\", {\"align\": \"colon\"}],\n \"keyword-spacing\" : [\"error\"],\n \"linebreak-style\" : [\"error\"],\n \"new-cap\" : [\"error\", {\"capIsNew\": false}],\n \"no-array-constructor\" : [\"error\"],\n \"no-multi-assign\" : [\"error\"],\n \"no-nested-ternary\" : [\"error\"],\n \"no-whitespace-before-property\": [\"error\"],\n \"object-curly-newline\" : [\"error\"],\n \"object-curly-spacing\" : [\"error\"],\n \"prefer-object-spread\" : [\"error\"],\n \"quotes\" : [\"error\", \"single\"],\n \"semi\" : [\"error\", \"never\"],\n \"no-trailing-spaces\" : [\"error\"]\n // \"multiline-comment-style\" : [\"error\", \"starred-block\"]\n }\n}" }, { "path": ".github/CODEOWNERS", "content": "* @millsp" }, { "path": ".github/FUNDING.yml", "content": "github: millsp\ncustom: https://www.buymeacoffee.com/millsp\npatreon: millsp\n" }, { "path": ".github/ISSUE_TEMPLATE/---bug-report.md", "content": "---\nname: \"๐Ÿž Bug Report\"\nabout: \"Something isn't working well ๐Ÿ’”\"\n\n---\n\n## ๐Ÿž Bug Report\n\n#### Describe the bug\n\n\n#### Reproduce the bug\n```ts\n// REPL or a link to your repository if applicable.\n// A *self-contained* demonstration of the problem.\n```\n\n#### Expected behavior\n\n\n#### Possible Solution\n\n\n#### Screenshots\n\n\n#### Additional context\n\n" }, { "path": ".github/ISSUE_TEMPLATE/---feature-request.md", "content": "---\nname: \"๐Ÿฉ Feature Request\"\nabout: \"Suggest an idea for this project ๐Ÿ’ก\"\n\n---\n\n## ๐Ÿฉ Feature Request\n\n#### Is your feature request related to a problem?\n\n\n#### Describe the solution you'd like\n\n\n#### Describe alternatives you've considered\n\n\n#### Teachability, Documentation, Adoption, Migration Strategy\n\n" }, { "path": ".github/pull_request_template.md", "content": "## ๐ŸŽ Pull Request\n\n\n* [ ] Used a clear / meaningful title for this pull request\n* [ ] Tested the changes in your own code (on your projects)\n* [ ] Added / Edited tests to reflect changes (`tests` folder)\n* [ ] Have read the **Contributing** part of the **Readme**\n* [ ] Passed `npm test`\n\n\n\n#### Fixes\n\n\n#### Why have you made changes?\n\n\n#### What changes have you made?\n* changed this to achieve this\n* changed that to achieve this\n* ...\n\n#### What tests have you updated?\n* tested this in `tests/...`\n* tested that in `tests/...`\n* ...\n\n#### Is there any breaking changes?\n\n* [ ] Yes, I changed the public API & documented it\n* [ ] Yes, I changed existing tests\n* [ ] No, I added to the public API & documented it\n* [ ] No, I added to the existing tests\n* [ ] I don't know\n\n#### Anything else worth mentioning?\n\n\n\n" }, { "path": ".github/stale.yml", "content": "# Number of days of inactivity before an issue becomes stale\ndaysUntilStale: 60\n# Number of days of inactivity before a stale issue is closed\ndaysUntilClose: 7\n# Issues with these labels will never be considered stale\nexemptLabels:\n - pinned #todo\n - security\n# Label to use when marking an issue as stale\nstaleLabel: wontfix\n# Comment to post when marking an issue as stale. Set to `false` to disable\nmarkComment: >\n This issue has been automatically marked as stale because it has not had\n recent activity. It will be closed if no further activity occurs. Thank you\n for your contributions.\n# Comment to post when closing a stale issue. Set to `false` to disable\ncloseComment: false\n" }, { "path": ".gitignore", "content": "package-lock.json\nnode_modules\n.vscode\n*.tgz\ndocs\nout\ndt" }, { "path": ".huskyrc.json", "content": "{\n \"hooks\": {\n \"commit-msg\": \"commitlint -E HUSKY_GIT_PARAMS\"\n }\n}" }, { "path": ".travis.yml", "content": "# https://docs.travis-ci.com/user/job-lifecycle\n\nlanguage: node_js\n\nnode_js:\n- '12.0'\n\ngit:\n depth: 5\n\ninstall:\n- npm install --only=dev\n\nenv:\n - DEPLOY=true\n\nstages:\n - test\n - deploy:master\n - deploy:branch\n - deploy:docs\n\njobs:\n include:\n - stage: test\n if: tag IS blank # filter double build with tags\n script:\n - npm run test \n deploy:\n edge: true\n provider: npm\n email: $NPM_EMAIL\n api_key: $NPM_TOKEN\n skip_cleanup: true\n tag: test\n on:\n all_branches: true\n before_deploy: # https://github.com/travis-ci/travis-ci/issues/1574#issuecomment-451787844\n - if ! npm run ci:test:bd; then travis_terminate 1; fi\n after_deploy: # the above link explains how to make the build fail if something went wrong\n - if ! npm run ci:test:ad; then travis_terminate 1; fi\n\n - stage: deploy:master\n if: tag IS blank AND branch = master AND fork = false AND env(DEPLOY) = true\n deploy:\n edge: true\n provider: npm\n email: $NPM_EMAIL\n api_key: $NPM_TOKEN\n tag: latest\n skip_cleanup: true\n on:\n all_branches: true\n before_deploy:\n - if ! npm run ci:master:bd; then travis_terminate 1; fi\n after_deploy:\n - if ! npm run ci:master:ad; then travis_terminate 1; fi\n \n - stage: deploy:branch\n if: tag IS blank AND branch != master AND fork = false AND env(DEPLOY) = true\n deploy:\n edge: true\n provider: npm\n email: $NPM_EMAIL\n api_key: $NPM_TOKEN\n tag: $TRAVIS_BRANCH\n skip_cleanup: true\n on:\n all_branches: true\n before_deploy:\n - if ! npm run ci:branch:bd; then travis_terminate 1; fi\n after_deploy:\n - if ! npm run ci:branch:ad; then travis_terminate 1; fi\n\n - stage: deploy:docs #deploys doc to gh-pages branch\n if: tag IS blank AND branch = master AND fork = false AND env(DEPLOY) = true\n deploy:\n edge: true\n provider: pages\n skip_cleanup: true\n github_token: $GH_TOKEN\n local_dir: \"docs\"\n keep_history: true\n on:\n all_branches: true\n before_deploy:\n - if ! npm run ci:docs:bd; then travis_terminate 1; fi\n after_deploy:\n - if ! npm run ci:docs:ad; then travis_terminate 1; fi\n" }, { "path": ".versionrc.json", "content": "{\n \"types\": [\n {\"type\": \"feat\", \"section\": \"Features\"},\n {\"type\": \"fix\", \"section\": \"Bug Fixes\"},\n {\"type\": \"build\", \"section\": \"Others\"},\n {\"type\": \"ci\", \"section\": \"Others\"},\n {\"type\": \"chore\", \"section\": \"Others\"},\n {\"type\": \"docs\", \"section\": \"Others\"},\n {\"type\": \"perf\", \"section\": \"Others\"},\n {\"type\": \"refactor\", \"section\": \"Others\"},\n {\"type\": \"revert\", \"section\": \"Others\"},\n {\"type\": \"style\", \"section\": \"Others\"},\n {\"type\": \"test\", \"section\": \"Others\"}\n ]\n}" }, { "path": "CHANGELOG.md", "content": "# Changelog\n\nAll notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.\n\n## [9.6.0](https://github.com/millsp/ts-toolbelt/compare/v9.5.1...v9.6.0) (2021-03-10)\n\n\n### Features\n\n* **paths:** parameter for AutoPath delimiter ([6d5bbdc](https://github.com/millsp/ts-toolbelt/commit/6d5bbdc834ce15dd3339d101c828457b1a34cce4))\n\n\n### Bug Fixes\n\n* **f.autopath:** distribute ([29eddd9](https://github.com/millsp/ts-toolbelt/commit/29eddd99c6826696941c50681ce4858243786110))\n* **f.autopath:** do not show primitive props ([1ad2638](https://github.com/millsp/ts-toolbelt/commit/1ad26389aa6a9a795d19d90d2724c73ae2bd51d9))\n* **f.autopath:** no primitve paths ([2bdb477](https://github.com/millsp/ts-toolbelt/commit/2bdb4778325288154c8f71c0a5ae4a1b7e2b217f))\n* **f.narrow:** fix variance and array inference ([4c7618d](https://github.com/millsp/ts-toolbelt/commit/4c7618d77b07d6b8c6dfd5087aa85a073bf57db3))\n* **f.narrow:** higher order function support ([dad05ee](https://github.com/millsp/ts-toolbelt/commit/dad05eec6e6710ea4f63063658a3dee4d9c0ca28))\n* **f.narrow:** preserve fns and better display ([a0d62d8](https://github.com/millsp/ts-toolbelt/commit/a0d62d8cfcd28eab7132c225ba187556ca749b4d))\n* **f.narrow:** preserve functions ([c34f1b9](https://github.com/millsp/ts-toolbelt/commit/c34f1b95d0e0855203104eb696cfcb8221a65374))\n* **f.narrow:** revert variance fixes ([12e014a](https://github.com/millsp/ts-toolbelt/commit/12e014a3f3d34047a3722486a73493f857a3697a))\n* **f.narrow:** variance ([866ecd7](https://github.com/millsp/ts-toolbelt/commit/866ecd76744fc38244d85e7ef7b4bb90105cf7eb))\n* **fn:** allow for curried in compose ([2bc5604](https://github.com/millsp/ts-toolbelt/commit/2bc560446916b423977c25e396b4f1f310b6c03f))\n* **o.paths:** dive within arrays and deeper ([626beb6](https://github.com/millsp/ts-toolbelt/commit/626beb61b3100c5e4fd699c946e0e2fed7e24cb6))\n\n\n### Others\n\n* **list:** more flexible keys ([d9415b2](https://github.com/millsp/ts-toolbelt/commit/d9415b2f85633c7c74a815c9909899114faf530c))\n* **o.p:** re-implement ([0f44362](https://github.com/millsp/ts-toolbelt/commit/0f443626dc3b114b6784d2053510a1e0c2f7f839))\n* **release:** 9.5.10 ([1f3928a](https://github.com/millsp/ts-toolbelt/commit/1f3928a70ff2a7e903a5398b53295c9c9997b42c))\n* **release:** 9.5.11 ([bde9210](https://github.com/millsp/ts-toolbelt/commit/bde9210d0a361ddb1e03920a0c2bd42dad17ee30))\n* **release:** 9.5.12 ([80579e1](https://github.com/millsp/ts-toolbelt/commit/80579e1eaa17b2d1c61bd7881d0ea6ff94753141))\n* **release:** 9.5.13 ([277a6e2](https://github.com/millsp/ts-toolbelt/commit/277a6e2ac5ca8be2bbcd7593d987aaac3ea9bb75))\n* **release:** 9.5.2 ([ec4a953](https://github.com/millsp/ts-toolbelt/commit/ec4a953cabe6c4d704c0dca5f37d1dc630de047b))\n* **release:** 9.5.3 ([0836f6e](https://github.com/millsp/ts-toolbelt/commit/0836f6e8187287a0c86f249e4e552d68a44e4f60))\n* **release:** 9.5.4 ([855855e](https://github.com/millsp/ts-toolbelt/commit/855855e520ed4a04059f9d61884d2045dd0d751b))\n* **release:** 9.5.5 ([e28bddf](https://github.com/millsp/ts-toolbelt/commit/e28bddf33066850a764e2ba344883ff84da561b9))\n* **release:** 9.5.6 ([b8e0d0a](https://github.com/millsp/ts-toolbelt/commit/b8e0d0a83228baf666e00f4fdb0d99ca936c133f))\n* **release:** 9.5.7 ([5646455](https://github.com/millsp/ts-toolbelt/commit/564645547862c7d698f4a03b15ccb7a5ffb5fc29))\n* **release:** 9.5.8 ([bceb8be](https://github.com/millsp/ts-toolbelt/commit/bceb8be67701f9c7aba9608aed851567e8118ca5))\n* **release:** 9.5.9 ([533a6ac](https://github.com/millsp/ts-toolbelt/commit/533a6ac0f7b713933c94f0962166c7a0245b055e))\n* **release:** 9.6.0 ([5e6d008](https://github.com/millsp/ts-toolbelt/commit/5e6d008888c1705e41bf752b3a308323a5c563fe))\n* **string:** instantiation limiters ([9a678d8](https://github.com/millsp/ts-toolbelt/commit/9a678d8a400c97436d428dad05405abb154af958))\n* **update:** remove dirty code ([9d0ff64](https://github.com/millsp/ts-toolbelt/commit/9d0ff6441518c2c9a01cea7726c08acd19eb37d9))\n* cleanup ([6f23f2e](https://github.com/millsp/ts-toolbelt/commit/6f23f2ec79145a0545eb45d15d50d0363a119b12))\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to make participation in our project and\nour community a harassment-free experience for everyone, regardless of age, body\nsize, disability, ethnicity, sex characteristics, gender identity and expression,\nlevel of experience, education, socio-economic status, nationality, personal\nappearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment\ninclude:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or\n advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic\n address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable\nbehavior and are expected to take appropriate and fair corrective action in\nresponse to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or\nreject comments, commits, code, wiki edits, issues, and other contributions\nthat are not aligned to this Code of Conduct, or to ban temporarily or\npermanently any contributor for other behaviors that they deem inappropriate,\nthreatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies within all project spaces, and it also applies when\nan individual is representing the project or its community in public spaces.\nExamples of representing a project or community include using an official\nproject e-mail address, posting via an official social media account, or acting\nas an appointed representative at an online or offline event. Representation of\na project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported by contacting the project team at [gitter.im/millsp](https://gitter.im/millsp). All\ncomplaints will be reviewed and investigated and will result in a response that\nis deemed necessary and appropriate to the circumstances. The project team is\nobligated to maintain confidentiality with regard to the reporter of an incident.\nFurther details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good\nfaith may face temporary or permanent repercussions as determined by other\nmembers of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,\navailable at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see\nhttps://www.contributor-covenant.org/faq\n\n" }, { "path": "CONTRIBUTING.md", "content": "Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. There are many ways to contribute to the project:\n\n### Community\n\n* [Help the community with answers on Gitter](https://gitter.im/ts-toolbelt/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link)\n* [Reporting bugs or requesting new features](https://github.com/millsp/ts-toolbelt/issues/new/choose)\n\n### Codebase\n\n* Improving existing documentation \n* Adding new types to the collection\n* [Getting involved with things to do](#-whats-next)\n\n### Pull Requests\n\n1. [Read the tutorial](https://medium.com/free-code-camp/typescript-curry-ramda-types-f747e99744ab)\n\n2. Fork the project\n\n3. Clone your fork\n\n4. Create a pr/**feature** branch\n\n ```sh\n git checkout -b pr/CoolFeature\n ```\n \n5. Commit your changes\n\n You **must** follow the [conventional commit](https://conventionalcommits.org) to be able to commit\n ```sh\n git commit -m \"feat(name): Added this CoolFeature\"\n ```\n\n6. [Run the tests](#-running-tests)\n\n7. Push your changes\n\n ```sh\n npm run release -- --no-tags\n ```\n\n8. Open a pull request\n" }, { "path": "LICENSE", "content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright 2019 Pierre-Antoine Mills\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License." }, { "path": "README.md", "content": "

\n \n \"banner\"\n \n

TypeScript's largest utility library

\n

\n\n

\n \n \n \n \n \n \n \n \n \n

\n\n

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n\n

\n ๐Ÿ“– Documentation\n ยท\n ๐Ÿ“ฃ Announcements\n ยท\n ๐Ÿž Report Bug\n ยท\n ๐Ÿฉ Request Feature\n ยท\n ๐Ÿค” Ask Questions\n

\n\n## About\n\n**ts-toolbelt** is the largest, and most tested type library available right\nnow, featuring **+200 utilities**. Our type collection packages some of the most\nadvanced mapped types, conditional types, and recursive types on the market.\n\n**Spend less time, build stronger**. Benefit from a wide range of generic type\nfunctions to achieve better type safety. \n\nWe work just like lodash, or ramda, but applied to the type system. Our mission\nis to provide you with simple ways to compute, change, and create types. We\nabstract all those complex type checks away for you. We provide a simple,\nreusable, and standard API to help you get more done with TypeScript.\n\n**ts-toolbelt** is a well organized package that can help you perform advanced\noperations on object types, union types, as well as function, and literal types.\nIt is carefully and coherently designed for building robust, flexible, and\ntype-safe software.\n\n

\n \n \"demo\"\n \n

\n\nWe are a community and a knowledge base. Everyone is welcome to ask questions\nabout types. If you are stuck or you misunderstand something, you came to the\nright place!. We welcome beginners and advanced developers to come take part.\n**Welcome!**\n\n## Getting Started\n\n### Prerequisites\n\n```sh\nnpm install typescript@^4.1.0 --save-dev\n```\n\nFor best results, add this to your `tsconfig.json`\n\n```ts\n{\n \"compilerOptions\": {\n // highly recommended (required by few utilities)\n \"strictNullChecks\": true,\n\n // this is optional, but enable whenever possible\n \"strict\": true,\n\n // this is the lowest supported standard library\n \"lib\": [\"es2015\"],\n }\n}\n```\n\n### Installation\n\n```sh\nnpm install ts-toolbelt --save\n```\n\n### Hello World\n\n```ts\nimport {Object} from \"ts-toolbelt\"\n// Check the docs below for more\n\n// Merge two `object` together\ntype merge = Object.Merge<{name: string}, {age?: number}>\n// {name: string, age?: number}\n\n// Make a field of an `object` optional\ntype optional = Object.Optional<{id: number, name: string}, \"name\">\n// {id: number, name?: string}\n```\n\nYou can [**level-up, and re-code this library from\nscratch**](https://medium.com/free-code-camp/typescript-curry-ramda-types-f747e99744ab).\n\n## [Documentation โคข](https://millsp.github.io/ts-toolbelt/)\n\n### Imports\n\nThe project is organized around TypeScript's main concepts:\n\n| **Any** | **Boolean** | **Class** | **Function** | **Iteration** | **List** |\n|------------|-------------|--------------|--------------|---------------|----------|\n| **Number** | **Object** | **Object.P** | **String** | **Union** | **Test** |\n\n> **`TIP`** How to choose categories? Match your type with them.\n\nThere are many ways to import the types into your project:\n\n* **Explicit**\n ```ts\n import {Any, Boolean, Class, Function, Iteration, List, Number, Object, String, Union} from \"ts-toolbelt\"\n ```\n\n* **Compact**\n ```ts\n import {A, B, C, F, I, L, N, O, S, U} from \"ts-toolbelt\"\n ```\n\n* **Portable**\n ```ts\n import tb from \"ts-toolbelt\"\n ```\n\nYou can also import our non-official API from the community:\n ```ts\n import {Community} from \"ts-toolbelt\"\n ```\n\n> **`TIP`** The community API is for our community to publish useful types that\n> don't see fit in the standard API.\n\n### Utility Index\n\n|ANY|OBJECT|LIST|FUNCTION|STRING|UNION|CLASS|BOOLEAN|NUMBER|OBJECT.P|ITERATION|\n|---|---|---|---|---|---|---|---|---|---|---|\n|[Await](https://millsp.github.io/ts-toolbelt/modules/any_await.html)|[Assign](https://millsp.github.io/ts-toolbelt/modules/object_assign.html)|[Append](https://millsp.github.io/ts-toolbelt/modules/list_append.html)|[AutoPath](https://millsp.github.io/ts-toolbelt/modules/function_autopath.html)|[At](https://millsp.github.io/ts-toolbelt/modules/string_at.html)|[Diff](https://millsp.github.io/ts-toolbelt/modules/union_diff.html)|[Class](https://millsp.github.io/ts-toolbelt/modules/class_class.html)|[And](https://millsp.github.io/ts-toolbelt/modules/boolean_and.html)|[Absolute](https://millsp.github.io/ts-toolbelt/modules/number_absolute.html)|[Merge](https://millsp.github.io/ts-toolbelt/modules/object_p_merge.html)|[Iteration](https://millsp.github.io/ts-toolbelt/modules/iteration_iteration.html)|\n|[At](https://millsp.github.io/ts-toolbelt/modules/any_at.html)|[AtLeast](https://millsp.github.io/ts-toolbelt/modules/object_atleast.html)|[Assign](https://millsp.github.io/ts-toolbelt/modules/list_assign.html)|[Compose](https://millsp.github.io/ts-toolbelt/modules/function_compose.html)|[Join](https://millsp.github.io/ts-toolbelt/modules/string_join.html)|[Exclude](https://millsp.github.io/ts-toolbelt/modules/union_exclude.html)|[Instance](https://millsp.github.io/ts-toolbelt/modules/class_instance.html)|[Not](https://millsp.github.io/ts-toolbelt/modules/boolean_not.html)|[Add](https://millsp.github.io/ts-toolbelt/modules/number_add.html)|[Omit](https://millsp.github.io/ts-toolbelt/modules/object_p_omit.html)|[IterationOf](https://millsp.github.io/ts-toolbelt/modules/iteration_iterationof.html)|\n|[Cast](https://millsp.github.io/ts-toolbelt/modules/any_cast.html)|[Compulsory](https://millsp.github.io/ts-toolbelt/modules/object_compulsory.html)|[AtLeast](https://millsp.github.io/ts-toolbelt/modules/list_atleast.html)|[Curry](https://millsp.github.io/ts-toolbelt/modules/function_curry.html)|[Length](https://millsp.github.io/ts-toolbelt/modules/string_length.html)|[Filter](https://millsp.github.io/ts-toolbelt/modules/union_filter.html)|[Parameters](https://millsp.github.io/ts-toolbelt/modules/class_parameters.html)|[Or](https://millsp.github.io/ts-toolbelt/modules/boolean_or.html)|[Greater](https://millsp.github.io/ts-toolbelt/modules/number_greater.html)|[Pick](https://millsp.github.io/ts-toolbelt/modules/object_p_pick.html)|[Key](https://millsp.github.io/ts-toolbelt/modules/iteration_key.html)|\n|[Compute](https://millsp.github.io/ts-toolbelt/modules/any_compute.html)|[CompulsoryKeys](https://millsp.github.io/ts-toolbelt/modules/object_compulsorykeys.html)|[Compulsory](https://millsp.github.io/ts-toolbelt/modules/list_compulsory.html)|[Exact](https://millsp.github.io/ts-toolbelt/modules/function_exact.html)|[Replace](https://millsp.github.io/ts-toolbelt/modules/string_replace.html)|[Has](https://millsp.github.io/ts-toolbelt/modules/union_has.html)||[Xor](https://millsp.github.io/ts-toolbelt/modules/boolean_xor.html)|[GreaterEq](https://millsp.github.io/ts-toolbelt/modules/number_greatereq.html)|[Readonly](https://millsp.github.io/ts-toolbelt/modules/object_p_readonly.html)|[Next](https://millsp.github.io/ts-toolbelt/modules/iteration_next.html)|\n|[Contains](https://millsp.github.io/ts-toolbelt/modules/any_contains.html)|[Diff](https://millsp.github.io/ts-toolbelt/modules/object_diff.html)|[CompulsoryKeys](https://millsp.github.io/ts-toolbelt/modules/list_compulsorykeys.html)|[Function](https://millsp.github.io/ts-toolbelt/modules/function_function.html)|[Split](https://millsp.github.io/ts-toolbelt/modules/string_split.html)|[IntersectOf](https://millsp.github.io/ts-toolbelt/modules/union_intersectof.html)|||[IsNegative](https://millsp.github.io/ts-toolbelt/modules/number_isnegative.html)|[Update](https://millsp.github.io/ts-toolbelt/modules/object_p_update.html)|[Pos](https://millsp.github.io/ts-toolbelt/modules/iteration_pos.html)|\n|[Equals](https://millsp.github.io/ts-toolbelt/modules/any_equals.html)|[Either](https://millsp.github.io/ts-toolbelt/modules/object_either.html)|[Concat](https://millsp.github.io/ts-toolbelt/modules/list_concat.html)|[Length](https://millsp.github.io/ts-toolbelt/modules/function_length.html)||[Last](https://millsp.github.io/ts-toolbelt/modules/union_last.html)|||[IsPositive](https://millsp.github.io/ts-toolbelt/modules/number_ispositive.html)|[Record](https://millsp.github.io/ts-toolbelt/modules/object_p_record.html)|[Prev](https://millsp.github.io/ts-toolbelt/modules/iteration_prev.html)|\n|[Extends](https://millsp.github.io/ts-toolbelt/modules/any_extends.html)|[Exclude](https://millsp.github.io/ts-toolbelt/modules/object_exclude.html)|[Diff](https://millsp.github.io/ts-toolbelt/modules/list_diff.html)|[Narrow](https://millsp.github.io/ts-toolbelt/modules/function_narrow.html)||[Merge](https://millsp.github.io/ts-toolbelt/modules/union_merge.html)|||[IsZero](https://millsp.github.io/ts-toolbelt/modules/number_iszero.html)|||\n|[Key](https://millsp.github.io/ts-toolbelt/modules/any_key.html)|[ExcludeKeys](https://millsp.github.io/ts-toolbelt/modules/object_excludekeys.html)|[Drop](https://millsp.github.io/ts-toolbelt/modules/list_drop.html)|[NoInfer](https://millsp.github.io/ts-toolbelt/modules/function_noinfer.html)||[NonNullable](https://millsp.github.io/ts-toolbelt/modules/union_nonnullable.html)|||[Lower](https://millsp.github.io/ts-toolbelt/modules/number_lower.html)|||\n|[Keys](https://millsp.github.io/ts-toolbelt/modules/any_keys.html)|[Filter](https://millsp.github.io/ts-toolbelt/modules/object_filter.html)|[Either](https://millsp.github.io/ts-toolbelt/modules/list_either.html)|[Parameters](https://millsp.github.io/ts-toolbelt/modules/function_parameters.html)||[Nullable](https://millsp.github.io/ts-toolbelt/modules/union_nullable.html)|||[LowerEq](https://millsp.github.io/ts-toolbelt/modules/number_lowereq.html)|||\n|[KnownKeys](https://millsp.github.io/ts-toolbelt/modules/any_knownkeys.html)|[FilterKeys](https://millsp.github.io/ts-toolbelt/modules/object_filterkeys.html)|[Exclude](https://millsp.github.io/ts-toolbelt/modules/list_exclude.html)|[Pipe](https://millsp.github.io/ts-toolbelt/modules/function_pipe.html)||[Pop](https://millsp.github.io/ts-toolbelt/modules/union_pop.html)|||[Negate](https://millsp.github.io/ts-toolbelt/modules/number_negate.html)|||\n|[Is](https://millsp.github.io/ts-toolbelt/modules/any_is.html)|[Has](https://millsp.github.io/ts-toolbelt/modules/object_has.html)|[ExcludeKeys](https://millsp.github.io/ts-toolbelt/modules/list_excludekeys.html)|[Promisify](https://millsp.github.io/ts-toolbelt/modules/function_promisify.html)||[Replace](https://millsp.github.io/ts-toolbelt/modules/union_replace.html)|||[Range](https://millsp.github.io/ts-toolbelt/modules/number_range.html)|||\n|[Promise](https://millsp.github.io/ts-toolbelt/modules/any_promise.html)|[HasPath](https://millsp.github.io/ts-toolbelt/modules/object_haspath.html)|[Extract](https://millsp.github.io/ts-toolbelt/modules/list_extract.html)|[Return](https://millsp.github.io/ts-toolbelt/modules/function_return.html)||[Select](https://millsp.github.io/ts-toolbelt/modules/union_select.html)|||[Sub](https://millsp.github.io/ts-toolbelt/modules/number_sub.html)|||\n|[Try](https://millsp.github.io/ts-toolbelt/modules/any_try.html)|[Includes](https://millsp.github.io/ts-toolbelt/modules/object_includes.html)|[Filter](https://millsp.github.io/ts-toolbelt/modules/list_filter.html)|[UnCurry](https://millsp.github.io/ts-toolbelt/modules/function_uncurry.html)||[Strict](https://millsp.github.io/ts-toolbelt/modules/union_strict.html)||||||\n|[Type](https://millsp.github.io/ts-toolbelt/modules/any_type.html)|[Intersect](https://millsp.github.io/ts-toolbelt/modules/object_intersect.html)|[FilterKeys](https://millsp.github.io/ts-toolbelt/modules/list_filterkeys.html)|[ValidPath](https://millsp.github.io/ts-toolbelt/modules/function_validpath.html)||[ListOf](https://millsp.github.io/ts-toolbelt/modules/union_listof.html)||||||\n|[x](https://millsp.github.io/ts-toolbelt/modules/any_x.html)|[IntersectKeys](https://millsp.github.io/ts-toolbelt/modules/object_intersectkeys.html)|[Flatten](https://millsp.github.io/ts-toolbelt/modules/list_flatten.html)|||||||||\n||[Invert](https://millsp.github.io/ts-toolbelt/modules/object_invert.html)|[Group](https://millsp.github.io/ts-toolbelt/modules/list_group.html)|||||||||\n||[ListOf](https://millsp.github.io/ts-toolbelt/modules/object_listof.html)|[Has](https://millsp.github.io/ts-toolbelt/modules/list_has.html)|||||||||\n||[Merge](https://millsp.github.io/ts-toolbelt/modules/object_merge.html)|[HasPath](https://millsp.github.io/ts-toolbelt/modules/list_haspath.html)|||||||||\n||[MergeAll](https://millsp.github.io/ts-toolbelt/modules/object_mergeall.html)|[Head](https://millsp.github.io/ts-toolbelt/modules/list_head.html)|||||||||\n||[Modify](https://millsp.github.io/ts-toolbelt/modules/object_modify.html)|[Includes](https://millsp.github.io/ts-toolbelt/modules/list_includes.html)|||||||||\n||[NonNullable](https://millsp.github.io/ts-toolbelt/modules/object_nonnullable.html)|[Intersect](https://millsp.github.io/ts-toolbelt/modules/list_intersect.html)|||||||||\n||[NonNullableKeys](https://millsp.github.io/ts-toolbelt/modules/object_nonnullablekeys.html)|[IntersectKeys](https://millsp.github.io/ts-toolbelt/modules/list_intersectkeys.html)|||||||||\n||[Nullable](https://millsp.github.io/ts-toolbelt/modules/object_nullable.html)|[KeySet](https://millsp.github.io/ts-toolbelt/modules/list_keyset.html)|||||||||\n||[NullableKeys](https://millsp.github.io/ts-toolbelt/modules/object_nullablekeys.html)|[Last](https://millsp.github.io/ts-toolbelt/modules/list_last.html)|||||||||\n||[Object](https://millsp.github.io/ts-toolbelt/modules/object_object.html)|[LastKey](https://millsp.github.io/ts-toolbelt/modules/list_lastkey.html)|||||||||\n||[Omit](https://millsp.github.io/ts-toolbelt/modules/object_omit.html)|[Length](https://millsp.github.io/ts-toolbelt/modules/list_length.html)|||||||||\n||[Optional](https://millsp.github.io/ts-toolbelt/modules/object_optional.html)|[List](https://millsp.github.io/ts-toolbelt/modules/list_list.html)|||||||||\n||[OptionalKeys](https://millsp.github.io/ts-toolbelt/modules/object_optionalkeys.html)|[Longest](https://millsp.github.io/ts-toolbelt/modules/list_longest.html)|||||||||\n||[Overwrite](https://millsp.github.io/ts-toolbelt/modules/object_overwrite.html)|[Merge](https://millsp.github.io/ts-toolbelt/modules/list_merge.html)|||||||||\n||[Partial](https://millsp.github.io/ts-toolbelt/modules/object_partial.html)|[MergeAll](https://millsp.github.io/ts-toolbelt/modules/list_mergeall.html)|||||||||\n||[Patch](https://millsp.github.io/ts-toolbelt/modules/object_patch.html)|[Modify](https://millsp.github.io/ts-toolbelt/modules/list_modify.html)|||||||||\n||[PatchAll](https://millsp.github.io/ts-toolbelt/modules/object_patchall.html)|[NonNullable](https://millsp.github.io/ts-toolbelt/modules/list_nonnullable.html)|||||||||\n||[Path](https://millsp.github.io/ts-toolbelt/modules/object_path.html)|[NonNullableKeys](https://millsp.github.io/ts-toolbelt/modules/list_nonnullablekeys.html)|||||||||\n||[Paths](https://millsp.github.io/ts-toolbelt/modules/object_paths.html)|[Nullable](https://millsp.github.io/ts-toolbelt/modules/list_nullable.html)|||||||||\n||[Pick](https://millsp.github.io/ts-toolbelt/modules/object_pick.html)|[NullableKeys](https://millsp.github.io/ts-toolbelt/modules/list_nullablekeys.html)|||||||||\n||[Readonly](https://millsp.github.io/ts-toolbelt/modules/object_readonly.html)|[ObjectOf](https://millsp.github.io/ts-toolbelt/modules/list_objectof.html)|||||||||\n||[ReadonlyKeys](https://millsp.github.io/ts-toolbelt/modules/object_readonlykeys.html)|[Omit](https://millsp.github.io/ts-toolbelt/modules/list_omit.html)|||||||||\n||[Record](https://millsp.github.io/ts-toolbelt/modules/object_record.html)|[Optional](https://millsp.github.io/ts-toolbelt/modules/list_optional.html)|||||||||\n||[Replace](https://millsp.github.io/ts-toolbelt/modules/object_replace.html)|[OptionalKeys](https://millsp.github.io/ts-toolbelt/modules/list_optionalkeys.html)|||||||||\n||[Required](https://millsp.github.io/ts-toolbelt/modules/object_required.html)|[Overwrite](https://millsp.github.io/ts-toolbelt/modules/list_overwrite.html)|||||||||\n||[RequiredKeys](https://millsp.github.io/ts-toolbelt/modules/object_requiredkeys.html)|[Partial](https://millsp.github.io/ts-toolbelt/modules/list_partial.html)|||||||||\n||[Select](https://millsp.github.io/ts-toolbelt/modules/object_select.html)|[Patch](https://millsp.github.io/ts-toolbelt/modules/list_patch.html)|||||||||\n||[SelectKeys](https://millsp.github.io/ts-toolbelt/modules/object_selectkeys.html)|[PatchAll](https://millsp.github.io/ts-toolbelt/modules/list_patchall.html)|||||||||\n||[Undefinable](https://millsp.github.io/ts-toolbelt/modules/object_undefinable.html)|[Path](https://millsp.github.io/ts-toolbelt/modules/list_path.html)|||||||||\n||[UndefinableKeys](https://millsp.github.io/ts-toolbelt/modules/object_undefinablekeys.html)|[Paths](https://millsp.github.io/ts-toolbelt/modules/list_paths.html)|||||||||\n||[Unionize](https://millsp.github.io/ts-toolbelt/modules/object_unionize.html)|[Pick](https://millsp.github.io/ts-toolbelt/modules/list_pick.html)|||||||||\n||[UnionOf](https://millsp.github.io/ts-toolbelt/modules/object_unionof.html)|[Pop](https://millsp.github.io/ts-toolbelt/modules/list_pop.html)|||||||||\n||[Update](https://millsp.github.io/ts-toolbelt/modules/object_update.html)|[Prepend](https://millsp.github.io/ts-toolbelt/modules/list_prepend.html)|||||||||\n||[Writable](https://millsp.github.io/ts-toolbelt/modules/object_writable.html)|[Readonly](https://millsp.github.io/ts-toolbelt/modules/list_readonly.html)|||||||||\n||[WritableKeys](https://millsp.github.io/ts-toolbelt/modules/object_writablekeys.html)|[ReadonlyKeys](https://millsp.github.io/ts-toolbelt/modules/list_readonlykeys.html)|||||||||\n|||[Remove](https://millsp.github.io/ts-toolbelt/modules/list_remove.html)|||||||||\n|||[Repeat](https://millsp.github.io/ts-toolbelt/modules/list_repeat.html)|||||||||\n|||[Replace](https://millsp.github.io/ts-toolbelt/modules/list_replace.html)|||||||||\n|||[Required](https://millsp.github.io/ts-toolbelt/modules/list_required.html)|||||||||\n|||[RequiredKeys](https://millsp.github.io/ts-toolbelt/modules/list_requiredkeys.html)|||||||||\n|||[Reverse](https://millsp.github.io/ts-toolbelt/modules/list_reverse.html)|||||||||\n|||[Select](https://millsp.github.io/ts-toolbelt/modules/list_select.html)|||||||||\n|||[SelectKeys](https://millsp.github.io/ts-toolbelt/modules/list_selectkeys.html)|||||||||\n|||[Shortest](https://millsp.github.io/ts-toolbelt/modules/list_shortest.html)|||||||||\n|||[Tail](https://millsp.github.io/ts-toolbelt/modules/list_tail.html)|||||||||\n|||[Take](https://millsp.github.io/ts-toolbelt/modules/list_take.html)|||||||||\n|||[Undefinable](https://millsp.github.io/ts-toolbelt/modules/list_undefinable.html)|||||||||\n|||[UndefinableKeys](https://millsp.github.io/ts-toolbelt/modules/list_undefinablekeys.html)|||||||||\n|||[Unionize](https://millsp.github.io/ts-toolbelt/modules/list_unionize.html)|||||||||\n|||[UnionOf](https://millsp.github.io/ts-toolbelt/modules/list_unionof.html)|||||||||\n|||[UnNest](https://millsp.github.io/ts-toolbelt/modules/list_unnest.html)|||||||||\n|||[Update](https://millsp.github.io/ts-toolbelt/modules/list_update.html)|||||||||\n|||[Writable](https://millsp.github.io/ts-toolbelt/modules/list_writable.html)|||||||||\n|||[WritableKeys](https://millsp.github.io/ts-toolbelt/modules/list_writablekeys.html)|||||||||\n|||[Zip](https://millsp.github.io/ts-toolbelt/modules/list_zip.html)|||||||||\n|||[ZipObj](https://millsp.github.io/ts-toolbelt/modules/list_zipobj.html)|||||||||\n\n### [Archives โคข](https://github.com/millsp/ts-toolbelt/tree/gh-pages)\n\n> **`EXAMPLE`** https://millsp.github.io/ts-toolbelt/4.2.1/\n\n## [Good to Know โคข](https://github.com/millsp/ts-toolbelt/discussions/categories/q-a)\n\nIn this wiki, you will find some extra resources for your learning, and\nunderstanding.\n\n**Are you missing something?** Participate to the open-wiki by [posting your\nquestions](https://github.com/millsp/ts-toolbelt/discussions/new).\n\n## Running tests\n\n### For this project\n\nTo run the `lint` & `type` tests, simply run:\n\n```sh\nnpm test\n```\n\n### For your project\n\nWant to test your own types? Let's get started:\n\n```ts\nimport {Number, Test} from \"ts-toolbelt\"\n\nconst {checks, check} = Test\n\nchecks([\n check, 31, Test.Pass>(),\n check, 2, Test.Pass>(),\n])\n```\n\n> **`TIP`** Place it in a file that won't be executed, it's just for TypeScript\n> to test types.\n\n### Continuous Integration\n\nThe releases are done with Travis CI in stages & whenever a branch or PR is\npushed:\n\n- Tests are run with `npm test`\n- Tests against\n [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/)\n- Releases to npm@[branch-name]\n\n## Compatibility\n\nThe project is maintained to adapt to the constant [changes of\nTypeScript](https://github.com/Microsoft/TypeScript/wiki/Roadmap):\n\n| ts-toolbelt | typescript |\n|-------------|------------|\n| 9.x.x | ^4.1.x |\n\nMajor version numbers will upgrade whenever TypeScript had breaking changes. \n\nOtherwise, the release versions will naturally follow the semantic versioning.\n\n## What's next\n\n* Automated performance tests\n ```sh\n # performance is checked manually with \n npx tsc --noEmit --extendedDiagnostics\n ```\n\n* Need to write more examples\n\n## License\n\n[![FOSSA\nStatus](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fpirix-gh%2Fts-toolbelt.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fpirix-gh%2Fts-toolbelt?ref=badge_large)\n" }, { "path": "SECURITY.md", "content": "If you have discovered a security vulnerability, please report it via [Tidelift](https://tidelift.com/security).\n" }, { "path": "package.json", "content": "{\n \"name\": \"ts-toolbelt\",\n \"version\": \"9.6.0\",\n \"description\": \"TypeScript's largest utility library\",\n \"keywords\": [\n \"safe\",\n \"tools\",\n \"types\",\n \"typesafe\",\n \"typescript\"\n ],\n \"homepage\": \"https://github.com/millsp/ts-toolbelt\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/millsp/ts-toolbelt\"\n },\n \"license\": \"Apache-2.0\",\n \"author\": {\n \"name\": \"Pierre-Antoine Mills\",\n \"url\": \"https://github.com/millsp\"\n },\n \"main\": \"out/index.js\",\n \"types\": \"out/index.d.ts\",\n \"files\": [\n \"out\"\n ],\n \"scripts\": {\n \"build:clean\": \"bash scripts/build/clean.sh\",\n \"build:code\": \"bash scripts/build/code.sh\",\n \"build:docs\": \"bash scripts/build/docs.sh\",\n \"build:types\": \"bash scripts/build/types.sh\",\n \"ci:branch:ad\": \"bash scripts/ci/branch/ad.sh\",\n \"ci:branch:bd\": \"bash scripts/ci/branch/bd.sh\",\n \"ci:docs:ad\": \"bash scripts/ci/docs/ad.sh\",\n \"ci:docs:bd\": \"bash scripts/ci/docs/bd.sh\",\n \"ci:master:ad\": \"bash scripts/ci/master/ad.sh\",\n \"ci:master:bd\": \"bash scripts/ci/master/bd.sh\",\n \"ci:test:ad\": \"bash scripts/ci/test/ad.sh\",\n \"ci:test:bd\": \"bash scripts/ci/test/bd.sh\",\n \"release\": \"bash scripts/release.sh\",\n \"test\": \"bash scripts/test/all.sh\",\n \"test:code\": \"bash scripts/test/code.sh\",\n \"test:lint\": \"bash scripts/test/lint.sh\",\n \"test:types\": \"bash scripts/test/types.sh\"\n },\n \"dependencies\": {},\n \"devDependencies\": {\n \"@commitlint/cli\": \"^11.0.0\",\n \"@commitlint/config-conventional\": \"^11.0.0\",\n \"@typescript-eslint/parser\": \"^4.14.0\",\n \"eledoc\": \"^0.2.0\",\n \"eslint\": \"^7.18.0\",\n \"eslint-plugin-fp\": \"^2.3.0\",\n \"eslint-plugin-react\": \"^7.22.0\",\n \"husky\": \"^4.3.0\",\n \"npx\": \"^10.2.0\",\n \"sort-package-json\": \"^1.48.0\",\n \"standard-version\": \"^9.1.0\",\n \"ts-node\": \"^9.1.0\",\n \"tslib\": \"^2.1.0\",\n \"typedoc\": \"^0.20.0\",\n \"typescript\": \"latest\"\n }\n}\n" }, { "path": "scripts/build/clean.sh", "content": "#!/bin/bash\n\nrm -fr out\nrm -fr docs\n" }, { "path": "scripts/build/code.sh", "content": "#!/bin/bash\n\nmkdir -p out\n\ntouch out/index.js\n" }, { "path": "scripts/build/docs.sh", "content": "#!/bin/bash\n\n# creates folder if it doesn't exist yet\nmkdir -p docs\n\n# get the current version of the package\nDOCS_VERSION=$(node -p \"require('./package.json').version\")\n\n# force typedoc to use higher ts version\nrm -rf node_modules/typedoc/node_modules/typescript\n# !\\ can cause bugs, be vigilent with it\n\n# generate docs their own version folder\nnpx typedoc --out \"docs/${DOCS_VERSION}\" sources --theme node_modules/eledoc/bin/default/ && \n\n# & for github to display them correctly\ntouch \"docs/${DOCS_VERSION}/.nojekyll\"\n" }, { "path": "scripts/build/types.sh", "content": "#!/bin/bash\n\nmkdir -p out\n\nnpx tsc sources/index.ts -d --emitDeclarationOnly --outDir out\n" }, { "path": "scripts/ci/branch/ad.sh", "content": "#!/bin/bash\n\nbash ./scripts/tools/check-deploy.sh\n" }, { "path": "scripts/ci/branch/bd.sh", "content": "#!/bin/bash\n\nnpm run build:clean\nnpm run build:code &&\nnpm run build:types\n" }, { "path": "scripts/ci/master/ad.sh", "content": "#!/bin/bash\n\nbash ./scripts/tools/check-deploy.sh" }, { "path": "scripts/ci/master/bd.sh", "content": "#!/bin/bash\n\nnpm run build:clean\nnpm run build:code &&\nnpm run build:types\n" }, { "path": "scripts/ci/test/ad.sh", "content": "#!/bin/bash\n\n# rm -fr dt\n\n# git clone --depth=1 https://github.com/DefinitelyTyped/DefinitelyTyped.git dt &&\n\n# npx ts-node scripts/tools/dt-update-version.ts &&\n\n# cd dt &&\n\n# git commit -am \"dependents testing\" &&\n\n# npm i &&\n\n# npm test\n" }, { "path": "scripts/ci/test/bd.sh", "content": "#!/bin/bash\n\nnpm run build:clean\n\nnpx ts-node scripts/tools/package-test-version.ts &&\nnpm run build:code &&\nnpm run build:types" }, { "path": "scripts/release.sh", "content": "#!/bin/bash\n\n# Make sure that we passed all tests\nnpm run test &&\n\n# Get the name of the current branch\nBRANCH=`git rev-parse --symbolic-full-name --abbrev-ref HEAD` &&\n\n# Sort package.json, keeps neat\nnpx sort-package-json &&\n\n# check if we have to do a release\nRELEASE=$(node -p \"require('./package.json').version.split('.')[2] === '0'\") &&\n\n# Publish the current branch origin\nif [ \"$BRANCH\" != \"master\" ]; then\n npx standard-version --skip.tag && # skip changelog\n git push origin $BRANCH # not a release\nelse\n if [ \"$RELEASE\" = \"false\" ]; then\n npx standard-version --skip.tag && # gen changelog\n git push origin $BRANCH\n else\n npx standard-version && # gen changelog\n git push origin $BRANCH --follow-tags # only releases\n fi;\nfi;\n" }, { "path": "scripts/test/all.sh", "content": "#!/bin/bash\n\nnpm run test:code &&\nnpm run test:lint &&\nnpm run test:types\n" }, { "path": "scripts/test/code.sh", "content": "#!/bin/bash\n" }, { "path": "scripts/test/lint.sh", "content": "#!/bin/bash\n\nnpx eslint 'sources/**'\n" }, { "path": "scripts/test/types.sh", "content": "#!/bin/bash\n\nnpx tsc --noEmit --diagnostics\n" }, { "path": "scripts/tools/check-deploy.sh", "content": "#!/bin/bash\n\nsleep 60s # we'll just wait a little for it to get propagated\n\n# we replace the travis branch name with \"latest\" if \"master\"\nPKG_VERSTAG=$(echo ${TRAVIS_BRANCH//master/latest})\n\n# we need to compare the current push and published versions\nPKG_VERSION=$(node -p \"require('./package.json').version\")\nPUB_VERSION=$(npm info .@${PKG_VERSTAG} version)\n\nif [ $PKG_VERSION != $PUB_VERSION ]; then\n echo \n exit 1 # travis has just failed the build, force to fail\nfi\n\nexit 0\n" }, { "path": "scripts/tools/dt-update-version.ts", "content": "import replace from './regex-update-file'\n\nreplace('./dt/types', '\"ts-toolbelt\": \".*\"', '\"ts-toolbelt\": \"test\"',\n [\n '?.*/package.json',\n ],\n [],\n)\n" }, { "path": "scripts/tools/package-test-version.ts", "content": "import replace from './regex-update-file'\n\nreplace('.', '\"version\": \"(?.*)\"', `\"version\": \"-test.${Date.now()}\"`,\n [\n 'package.json',\n ],\n [],\n)\n" }, { "path": "scripts/tools/regex-update-file.ts", "content": "// @ts-ignore\nimport * as fs from 'fs'\n// @ts-ignore\nimport * as rl from 'readline'\n\n// regex-update-file\n// regex-find-file\n\nconst updateMatchTo = (line: string, match: RegExp, to: string) => {\n const result = match.exec(line) || {groups: {}}\n const groups = result.groups\n\n // if user is not using groups just do\n if (!groups) return line.replace(match, to)\n\n Object.keys(groups).forEach((key) => {\n const groupMatch = new RegExp(`<${key}>`, 'gu')\n\n to = to.replace(groupMatch, groups[key])\n line = line.replace(match, to)\n })\n\n return line\n}\n\n\nconst replaceInFile = (\n file : string,\n path : string,\n match: RegExp,\n to : string,\n) => {\n let content = ''\n let didMatch = false\n\n const filePath = `${path}/${file}`\n const streamFD = fs.createReadStream(filePath)\n\n rl.createInterface(streamFD).\n on('line', (line: string) => {\n if (line.match(match)) {\n line = updateMatchTo(line, match, to)\n\n didMatch = true\n }\n\n content += `${line}\\n`\n }).\n on('close', () => {\n if (didMatch) {\n fs.writeFileSync(filePath, content)\n\n console.info(`wrote: ${filePath}`)\n }\n\n streamFD.close()\n })\n}\n\nconst isPathIncluded = (\n path: string,\n include: string[],\n exclude: string[],\n) => {\n // reduces down to `true` if a regex is a match\n const isExcluded = exclude.reduce((acc, val) => {\n return !!path.match(new RegExp(val, 'u')) || acc\n }, false)\n\n if (isExcluded)\n return false\n\n // reduces down to `true` if a regex is a match\n const isIncluded = include.reduce((acc, val) => {\n return !!path.match(new RegExp(val, 'u')) || acc\n }, false)\n\n return isIncluded\n}\n\nconst replaceInDir = (\n path : string,\n match : RegExp,\n replc : string,\n include: string[],\n exclude: string[],\n) => fs.readdir(path, 'utf8', (error: Error, docs: string[]) => {\n if (error)\n console.error(error)\n else {\n docs.forEach((doc) => {\n const docPath = `${path}/${doc}`\n\n if (fs.statSync(docPath).isDirectory()) {\n // it is important to add `/` for the regex matching\n if (isPathIncluded(`${docPath}/`, include, exclude))\n replaceInDir(docPath, match, replc, include, exclude)\n }\n\n if (fs.statSync(docPath).isFile()) {\n if (isPathIncluded(docPath, include, exclude))\n replaceInFile(doc, path, match, replc)\n }\n })\n }\n})\n\nconst pathToRegExp = (root: string) => (path: string) => {\n path = `^${root}/${path}`\n\n // // prepare insertion of different regexps\n // path = path.replace(/\\*\\*/gu, '[rec]') // .*\n // path = path.replace(/\\*/gu, '[any]') // [\\\\w\\\\.]+\n // // we do this because we can't replace '*'\n\n // // insert the regexps at their positions\n // path = path.replace(/\\[rec\\]/gu, '.*')\n // path = path.replace(/\\[any\\]/gu, '[\\\\w\\\\.]*')\n\n return `${path}$`\n}\n\nconst paths = (paths: string[]) => {\n let possibilities: string[] = []\n\n paths.forEach((path) => {\n possibilities = [\n ...possibilities, // merge previous\n ...path.split('/'). // split the path\n // @ts-ignore\n map((path, index, array) => { // get combination\n return array.slice(0, index + 1)\n }). // got combinations\n map((splitPath, index, splitPaths) => { // put it back as path\n if (index < splitPaths.length - 1) // add regex `$` for all\n return `${splitPath.join('/')}/$` // merge string back\n return splitPath.join('/') // but not the last one\n }),\n ]\n })\n\n return possibilities\n}\n\nconst replace = (\n path: string,\n match: string,\n replc: string,\n include: string[],\n exclude: string[],\n) => {\n // change/map paths to string regexps\n include = include.map(pathToRegExp(path))\n exclude = exclude.map(pathToRegExp(path))\n\n // only the end directory is included\n // so the algo can't follow by default\n // let's include all the possible paths\n const pathsInclude = paths(include)\n const pathsExclude = paths(exclude)\n\n include = include.concat(pathsInclude)\n exclude = exclude.concat(pathsExclude)\n\n // console.log(include)\n\n return replaceInDir(path, new RegExp(match, 'u'), replc, include, exclude)\n}\n\nexport default replace\n" }, { "path": "sources/Any/At.ts", "content": "import {Key} from './Key'\nimport {List} from '../List/List'\n\n/**\n * Get in `O` the type of a field of key `K`\n * @param O to extract from\n * @param K to extract at\n * @returns [[Any]]\n * @example\n * ```ts\n * import {O} from 'ts-toolbelt'\n *\n * type User = {\n * info: {\n * name: string\n * age: number\n * payment: {}\n * }\n * id: number\n * }\n *\n * type test0 = O.At // number\n * ```\n */\nexport type At =\n A extends List\n ? number extends A['length']\n ? K extends number | `${number}`\n ? A[never] | undefined\n : undefined\n : K extends keyof A ? A[K] : undefined\n : unknown extends A ? unknown :\n K extends keyof A ? A[K] :\n undefined;\n" }, { "path": "sources/Any/Await.ts", "content": "/**\n * Get the result type of a `Promise`\n * @param P A promise\n * @returns [[Any]]\n * @example\n * ```ts\n * import {C} from 'ts-toolbelt'\n *\n * const promise = new Promise((res, rej) => res('x'))\n *\n * type test0 = C.Await // string\n * type test1 = C.Await> // number\n * ```\n */\nexport type Await

=\n P extends Promise\n ? A\n : P\n" }, { "path": "sources/Any/Cast.ts", "content": "/**\n * Ask TS to re-check that `A1` extends `A2`.\n * And if it fails, `A2` will be enforced anyway.\n * Can also be used to add constraints on parameters.\n * @param A1 to check against\n * @param A2 to cast to\n * @returns `A1 | A2`\n * @example\n * ```ts\n * import {A} from 'ts-toolbelt'\n *\n * type test0 = A.Cast<'42', string> // '42'\n * type test1 = A.Cast<'42', number> // number\n * ```\n */\nexport type Cast =\n A1 extends A2\n ? A1\n : A2\n" }, { "path": "sources/Any/Compute.ts", "content": "import {Depth} from '../Object/_Internal'\nimport {BuiltIn} from '../Misc/BuiltIn'\nimport {Has} from '../Union/Has'\nimport {If} from './If'\nimport {Key} from './Key'\n\n/**\n * @hidden\n */\nexport type ComputeRaw =\n A extends Function\n ? A\n : {[K in keyof A]: A[K]} & unknown\n\n/**\n * @hidden\n */\ntype ComputeFlat =\n A extends BuiltIn ? A :\n A extends Array\n ? A extends Array>\n ? Array<{[K in keyof A[number]]: A[number][K]} & unknown>\n : A\n : A extends ReadonlyArray\n ? A extends ReadonlyArray>\n ? ReadonlyArray<{[K in keyof A[number]]: A[number][K]} & unknown>\n : A\n : {[K in keyof A]: A[K]} & unknown;\n\n/**\n * @hidden\n */\ntype ComputeDeep =\n A extends BuiltIn ? A : If, A, (\n A extends Array\n ? A extends Array>\n ? Array<{[K in keyof A[number]]: ComputeDeep} & unknown>\n : A\n : A extends ReadonlyArray\n ? A extends ReadonlyArray>\n ? ReadonlyArray<{[K in keyof A[number]]: ComputeDeep} & unknown>\n : A\n : {[K in keyof A]: ComputeDeep} & unknown\n )>;\n\n/**\n * Force TS to load a type that has not been computed (to resolve composed\n * types that TS haven't fully resolved, for display purposes mostly).\n * @param A to compute\n * @returns `A`\n * @example\n * ```ts\n * import {A} from 'ts-toolbelt'\n *\n * type test0 = A.Compute<{x: 'x'} & {y: 'y'}> // {x: 'x', y: 'y'}\n * ```\n */\nexport type Compute = {\n 'flat': ComputeFlat\n 'deep': ComputeDeep\n}[depth]\n" }, { "path": "sources/Any/Contains.ts", "content": "import {Extends} from './Extends'\n\n/**\n * Check whether `A1` is part of `A2` or not. It works like\n * [[Extends]] but [[Boolean]] results are narrowed to [[False]].\n * @param A1\n * @param A2\n * @returns [[Boolean]]\n * @example\n * ```ts\n * type test0 = A.Contains<'a' | 'b', 'b'> // False\n * type test1 = A.Contains<'a', 'a' | 'b'> // True\n *\n * type test2 = A.Contains<{a: string}, {a: string, b: number}> // False\n * type test3 = A.Contains<{a: string, b: number}, {a: string}> // True\n *\n * type test4 = A.Contains // False\n * /// Nothing cannot contain nothing, use `A.Equals`\n * ```\n */\nexport type Contains =\n Extends extends 1\n ? 1\n : 0\n" }, { "path": "sources/Any/Equals.ts", "content": "/**\n * Check whether `A1` is equal to `A2` or not.\n * @param A1\n * @param A2\n * @returns [[Boolean]]\n * @example\n * ```ts\n * import {A} from 'ts-toolbelt'\n *\n * type test0 = A.Equals<42 | 0, 42 | 0> // true\n * type test1 = A.Equals<{a: string}, {b: string}> // false\n * type test3 = A.Equals<{a: string}, {readonly a: string}> // false\n * ```\n */\nexport type Equals =\n (() => A extends A2 ? 1 : 0) extends (() => A extends A1 ? 1 : 0)\n ? 1\n : 0\n\n// Credit https://stackoverflow.com/a/52473108/3570903\n" }, { "path": "sources/Any/Extends.ts", "content": "/**\n * Check whether `A1` is part of `A2` or not. The difference with\n * `extends` is that it forces a [[Boolean]] return.\n * @param A1\n * @param A2\n * @returns [[Boolean]]\n * @example\n * ```ts\n * import {A} from 'ts-toolbelt'\n *\n * type test0 = A.Extends<'a' | 'b', 'b'> // Boolean\n * type test1 = A.Extends<'a', 'a' | 'b'> // True\n *\n * type test2 = A.Extends<{a: string}, {a: any}> // True\n * type test3 = A.Extends<{a: any}, {a: any, b: any}> // False\n *\n * type test4 = A.Extends // False\n * /// Nothing cannot extend nothing, use `A.Equals`\n * ```\n */\nexport type Extends =\n [A1] extends [never]\n ? 0\n : A1 extends A2\n ? 1\n : 0\n\n/*\n * Comes from the fact that `never` is a fall-through type that we want to\n * narrow down to `0`. So it means that `Extends` is false\n */\n" }, { "path": "sources/Any/If.ts", "content": "import {Boolean} from '../Boolean/_Internal'\n\nexport type If =\n B extends 1\n ? Then\n : Else\n" }, { "path": "sources/Any/Is.ts", "content": "import {Match} from './_Internal'\nimport {Extends} from './Extends'\nimport {Equals} from './Equals'\nimport {Contains} from './Contains'\n\n/**\n * Check whether `A` is similar to `A1` or not. In other words, it is a compact\n * type that bundles [[Equals]], [[Extends]], [[Contains]], comparison types.\n * @param A to be compared\n * @param A1 to compare to\n * @param match (?=`'default'`) to change precision\n * @returns [[Boolean]]\n * @example\n * ```ts\n * import {A} from 'ts-toolbelt'\n *\n * type test0 = A.Is<'a', 'a' | 'b', 'extends->'> // True\n * type test1 = A.Is<'a' | 'b', 'a', 'extends->'> // Boolean\n *\n * type test2 = A.Is<'a', 'a' | 'b', '<-extends'> // Boolean\n * type test3 = A.Is<'a' | 'b', 'a', '<-extends'> // True\n *\n * type test4 = A.Is<'a', 'a' | 'b', 'contains->'> // True\n * type test5 = A.Is<'a' | 'b', 'a', 'contains->'> // False\n *\n * type test6 = A.Is<'a', 'a' | 'b', '<-contains'> // False\n * type test7 = A.Is<'a' | 'b', 'a', '<-contains'> // True\n *\n * type test8 = A.Is<'a', 'a' | 'b', 'equals'> // False\n * type test9 = A.Is<'b' |'a', 'a' | 'b', 'equals'> // True\n * ```\n */\nexport type Is = {\n 'default' : Extends\n 'contains->': Contains\n 'extends->' : Extends\n '<-contains': Contains\n '<-extends' : Extends\n 'equals' : Equals\n}[match]\n" }, { "path": "sources/Any/Key.ts", "content": "/**\n * Describes index keys for any type\n */\nexport type Key = string | number | symbol\n" }, { "path": "sources/Any/Keys.ts", "content": "import {List} from '../List/List'\n\n/**\n * Get the keys of `A`\n * @param A\n * @returns [[Key]]\n * @example\n * ```ts\n * ```\n */\nexport type Keys =\n A extends List\n ? Exclude | number\n : keyof A\n" }, { "path": "sources/Any/KnownKeys.ts", "content": "import {Keys} from './Keys'\n\n/**\n * Get the known keys of an [[Object]]\n * @param O\n * @returns [[Key]]\n * @example\n * ```ts\n * ```\n */\nexport type KnownKeys = {\n [K in keyof O]:\n string extends K ? never :\n number extends K ? never :\n K\n} extends {\n [K in keyof O]: infer U\n} ? U & Keys : never;\n" }, { "path": "sources/Any/Promise.ts", "content": "/**\n * Create an asynchronous operation like the original `Promise` type but this\n * one prevents promises to be wrapped within more promises (not possible).\n * @param A\n * @example\n * ```ts\n * import {A} from 'ts-toolbelt'\n *\n * type test0 = A.Promise> // Promise\n * type test1 = Promise> // Promise>\n * ```\n */\nexport type Promise =\n globalThis.Promise<\n A extends globalThis.Promise\n ? X\n : A\n >\n" }, { "path": "sources/Any/Try.ts", "content": "/**\n * Similar to [[Cast]] but with a custom fallback `Catch`. If it fails,\n * it will enforce `Catch` instead of `A2`.\n * @param A1 to check against\n * @param A2 to try/test with\n * @param Catch to fallback to if the test failed\n * @returns `A1 | Catch`\n * @example\n * ```ts\n * import {A} from 'ts-toolbelt'\n *\n * type test0 = A.Try<'42', string> // '42'\n * type test1 = A.Try<'42', number> // never\n * type test1 = A.Try<'42', number, 'tried'> // 'tried'\n * ```\n */\nexport type Try =\n A1 extends A2\n ? A1\n : Catch\n" }, { "path": "sources/Any/Type.ts", "content": "import {Key} from './Key'\n\ndeclare const id: unique symbol\n\n/**\n * Create your own opaque sub-type from a type `A`\n * @param A to be personalized\n * @param Id to name the sub-type\n * @returns A new type `Type`\n * @example\n * ```ts\n * import {A} from 'ts-toolbelt'\n *\n * type EUR = A.Type\n * type USD = A.Type\n *\n * let eurWallet = 10 as EUR\n * let usdWallet = 15 as USD\n *\n * eurWallet = usdWallet // error\n * ```\n */\nexport type Type = {\n [id]: Id\n} & A\n" }, { "path": "sources/Any/_Internal.ts", "content": "/**\n * Describes the match strategy when matching types\n * * `default` : `extends->`\n * * `contains->` : X contains Y ([[Contains]])\n * * `extends->` : X extends Y ([[Extends]])\n * * `<-contains` : Y contains X ([[Contains]])\n * * `<-extends` : Y extends X ([[Extends]])\n * * `equals` : X equals Y (([[Equals]]))\n */\nexport type Match = | 'default'\n | 'contains->'\n | 'extends->'\n | '<-contains'\n | '<-extends'\n | 'equals'\n" }, { "path": "sources/Any/_api.ts", "content": "/** @ignore *//** */\n\nexport {Await} from './Await'\nexport {At} from './At'\nexport {Cast} from './Cast'\nexport {Compute} from './Compute'\nexport {Contains} from './Contains'\nexport {Equals} from './Equals'\nexport {Extends} from './Extends'\nexport {Key} from './Key'\nexport {Keys} from './Keys'\nexport {KnownKeys} from './KnownKeys'\nexport {Is} from './Is'\nexport {Promise} from './Promise'\nexport {Try} from './Try'\nexport {Type} from './Type'\nexport {x} from './x'\n" }, { "path": "sources/Any/x.ts", "content": "const _ = Symbol('x')\n\n/**\n * A placeholder that is used in various ways\n */\nexport type x = typeof _ & {}\n" }, { "path": "sources/Boolean/And.ts", "content": "import {Boolean} from './_Internal'\n\n/**\n * Logical `&&` operator (behaves like the JS one)\n * @param B1 Left-hand side\n * @param B2 Right-hand side\n * @returns [[Boolean]]\n * @example\n * ```ts\n * import {B} from 'ts-toolbelt'\n *\n * type test0 = B.And // False\n * type test1 = B.And // True\n * type test2 = B.And // Boolean\n * ```\n */\nexport type And = {\n 0: {\n 0: 0\n 1: 0\n }\n 1: {\n 0: 0\n 1: 1\n }\n}[B1][B2]\n\n" }, { "path": "sources/Boolean/Not.ts", "content": "import {Boolean} from './_Internal'\n\n/**\n * Logical `!` operator (behaves like the JS one)\n * @param B to negate\n * @returns [[Boolean]]\n * @example\n * ```ts\n * import {B} from 'ts-toolbelt'\n *\n * type test0 = B.Not // False\n * type test1 = B.Not // True\n * ```\n */\nexport type Not = {\n 0: 1\n 1: 0\n}[B]\n" }, { "path": "sources/Boolean/Or.ts", "content": "import {Boolean} from './_Internal'\n\n/**\n * Logical `||` operator (behaves like the JS one)\n * @param B1 Left-hand side\n * @param B2 Right-hand side\n * @returns [[Boolean]]\n * @example\n * ```ts\n * import {B} from 'ts-toolbelt'\n *\n * type test0 = B.Or // True\n * type test1 = B.Or // True\n * type test2 = B.Or // Boolean\n * ```\n */\nexport type Or = {\n 0: {\n 0: 0\n 1: 1\n }\n 1: {\n 0: 1\n 1: 1\n }\n}[B1][B2]\n" }, { "path": "sources/Boolean/Xor.ts", "content": "import {Boolean} from './_Internal'\n\n/**\n * Logical `^` operator (behaves like the JS one)\n * @param B1 Left-hand side\n * @param B2 Right-hand side\n * @returns [[Boolean]]\n * @example\n * ```ts\n * import {B} from 'ts-toolbelt'\n *\n * type test0 = B.Xor // False\n * type test1 = B.Xor // True\n * type test2 = B.Xor // Boolean\n * ```\n */\nexport type Xor = {\n 0: {\n 0: 0\n 1: 1\n }\n 1: {\n 0: 1\n 1: 0\n }\n}[B1][B2]\n" }, { "path": "sources/Boolean/_Internal.ts", "content": "export type Boolean = 0 | 1\n" }, { "path": "sources/Boolean/_api.ts", "content": "/** @ignore *//** */\n\nexport {And} from './And'\nexport {Not} from './Not'\nexport {Or} from './Or'\nexport {Xor} from './Xor'\n" }, { "path": "sources/Class/Class.ts", "content": "import {List} from '../List/List'\n\n/**\n * Alias to create/describe a `class`\n * @param P its constructor parameters\n * @param R the object it constructs\n * @returns `class`\n * @example\n * ```ts\n * import {C} from 'ts-toolbelt'\n *\n * type test0 = C.Class<[string, number], {a: string, b: number}>\n *\n * declare const SomeClass: test0\n *\n * const obj = new SomeClass('foo', 42) // {a: string, b: number}\n * ```\n */\nexport type Class

= {\n new (...args: P): R\n}\n" }, { "path": "sources/Class/Instance.ts", "content": "import {Class} from './Class'\n\n/**\n * Get the instance type of a `class` from a class object\n * @param C * *typeof** class\n * @returns [[Object]]\n * @example\n * ```ts\n * import {C} from 'ts-toolbelt'\n *\n * /// `create` takes an instance constructor and creates an instance of it\n * declare function create any)>(c: C): C.InstanceOf\n *\n * class A {}\n * class B {}\n *\n * let a = create(A) // A\n * let b = create(B) // B\n * ```\n */\nexport type Instance =\n C extends Class\n ? R\n : any\n" }, { "path": "sources/Class/Parameters.ts", "content": "import {Class} from './Class'\n\n/**\n * Get the parameters of a class constructor\n * @param C **typeof** class\n * @returns [[List]]\n * @example\n * ```ts\n * import {C} from 'ts-toolbelt'\n *\n * type User = C.Class<[string, string], {firstname: string, lastname: string}>\n *\n * type test0 = C.Parameters // [string, string]\n * ```\n */\nexport type Parameters =\n C extends Class\n ? P\n : never\n" }, { "path": "sources/Class/_api.ts", "content": "/** @ignore *//** */\n\nexport {Class} from './Class'\nexport {Instance} from './Instance'\nexport {Parameters} from './Parameters'\n" }, { "path": "sources/Community/IncludesDeep.ts", "content": "import {Match} from '../Any/_Internal'\nimport {UnionOf} from '../Object/UnionOf'\nimport {Next} from '../Iteration/Next'\nimport {Prev} from '../Iteration/Prev'\nimport {Iteration} from '../Iteration/Iteration'\nimport {IterationOf} from '../Iteration/IterationOf'\nimport {Is} from '../Any/Is'\nimport {Boolean} from '../Boolean/_Internal'\nimport {Cast} from '../Any/Cast'\nimport {Pos} from '../Iteration/Pos'\n\n/**\n * @hidden\n */\ntype _IncludesDeep> = {\n 0: _IncludesDeep : O, M, match, limit, Next>\n 1: 1\n 2: 0\n}[\n Pos> extends limit // if we go past the limit\n ? 2 // end the loop here\n : Is // if 0 => continue, if 1 => end\n]\n\n/**\n * Check whether `O`, or its sub-objects have fields that match `M`\n * where the maximum allowed depth is set with `limit`.\n *\n * @param O to be inspected\n * @param M to check field type\n * @param match (?=`'default'`) to change precision\n * @param limit (?=`'10'`) to change the check depth\n * @returns [[Boolean]]\n * @example\n * ```ts\n * ```\n * @author millsp, ctrlplusb\n */\nexport type IncludesDeep =\n _IncludesDeep extends infer X\n ? Cast\n : never\n" }, { "path": "sources/Community/IsLiteral.ts", "content": "import {And} from '../Boolean/And'\nimport {Or} from '../Boolean/Or'\nimport {Extends} from '../Any/Extends'\n\n/**\n * @hidden\n */\nexport type IsStringLiteral =\n A extends string\n ? string extends A\n ? 0\n : 1\n : 0\n\n/**\n * @hidden\n */\nexport type IsNumberLiteral =\n A extends number\n ? number extends A\n ? 0\n : 1\n : 0\n\n/**\n * Literal to restrict against\n */\nexport type Kind = string | number\n\n/**\n * Determine whether `A` is literal or not\n * @param A to be checked\n * @param kind (?=`'string' | 'number'`) to restrict\n * @example\n * ```ts\n * import {A} from 'ts-toolbelt'\n *\n * type test0 = A.IsLiteral<1 | 2> // 1\n * type test1 = A.IsLiteral<1 | 2, string> // 0\n * type test2 = A.IsLiteral<1 | '2', string> // 0 | 1\n * type test3 = A.IsLiteral // 0\n * ```\n */\nexport type IsLiteral =\n And, IsNumberLiteral>, Extends>\n" }, { "path": "sources/Community/_api.ts", "content": "/** @ignore *//** */\n\nexport {IncludesDeep} from './IncludesDeep'\nexport {IsLiteral} from './IsLiteral'\n" }, { "path": "sources/Function/AutoPath.ts", "content": "import {Key} from '../Any/Key'\nimport {Head} from '../List/Head'\nimport {List} from '../List/List'\nimport {Pop} from '../List/Pop'\nimport {Tail} from '../List/Tail'\nimport {Path} from '../Object/Path'\nimport {UnionOf} from '../Object/UnionOf'\nimport {Select} from '../Union/Select'\nimport {Join} from '../String/Join'\nimport {Split} from '../String/Split'\n\n/**\n * @ignore\n */\ntype Index = number | string;\n\n/**\n * @ignore\n */\ntype KeyToIndex> =\n number extends K ? Head : K & Index;\n\n/**\n * @ignore\n */\ntype MetaPath = [], P extends List = []> = {\n [K in keyof O]:\n | MetaPath, [...P, KeyToIndex]>\n | Join<[...P, KeyToIndex], D>;\n};\n\n/**\n * @ignore\n */\ntype NextPath =\n // the next paths after property `K` are on sub objects\n // O[K] === K | {x: '${K}.x' | {y: '${K}.x.y' ...}}\n // So we access O[K] then we only keep the next paths\n // To do this, we can just exclude `string` out of it:\n // O[K] === {x: '${K}.x' | {y: '${K}.x.y' ...}}\n // To do this, we create a union of what we just got\n // This will yield a union of paths and meta paths\n // We exclude the next paths (meta) paths by excluding\n // `object`. Then we are left with the direct next path\n Select & {}>, string>;\n\n/**\n * @ignore\n */\ntype ExecPath, Delimiter extends string> =\n // We go in the `MetaPath` of `O` to get the prop at `SP`\n // So we query what is going the `NextPath` at `O[...SP]`\n NextPath, SP>>;\n\n/**\n * @ignore\n */\ntype HintPath, Exec extends string, D extends string> = [Exec] extends [never] // if has not found paths\n ? ExecPath, D> // display previous paths\n : Exec | P; // display current + next\n\n/**\n * @ignore\n */\ntype _AutoPath = Split> =\n HintPath, D>;\n\n/**\n * Auto-complete, validate, and query the string path of an object `O`\n * @param O to work on\n * @param P path of `O`\n * @param D (?=`'.'`) delimiter for path\n *\n * ```ts\n * declare function get(\n * object: O, path: AutoPath\n * ): Path>\n *\n * declare const user: User\n *\n * type User = {\n * name: string\n * friends: User[]\n * }\n *\n * // works\n * const friendName = get(user, 'friends.40.name')\n * const friendFriendName = get(user, 'friends.40.friends.12.name')\n *\n * // errors\n * const friendNames = get(user, 'friends.40.names')\n * const friendFriendNames = get(user, 'friends.40.friends.12.names')\n * ```\n */\nexport type AutoPath =\n _AutoPath;\n" }, { "path": "sources/Function/Compose/List/Async.ts", "content": "/** @ignore *//** */\n\nimport {Function} from '../../Function'\nimport {Await} from '../../../Any/Await'\nimport {Curry} from '../../Curry'\n\n/**\n *@hidden\n */\nexport type ComposeListAsync = {\n <\n R0,\n P extends any[],\n >(fns: [\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n P extends any[],\n >(fns: [\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n P extends any[],\n >(fns: [\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n P extends any[],\n >(fns: [\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n P extends any[],\n >(fns: [\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n P extends any[],\n >(fns: [\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n P extends any[],\n >(fns: [\n Function<[Await], R6> | Curry], R6>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n P extends any[],\n >(fns: [\n Function<[Await], R7> | Curry], R7>>,\n Function<[Await], R6> | Curry], R6>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n P extends any[],\n >(fns: [\n Function<[Await], R8> | Curry], R8>>,\n Function<[Await], R7> | Curry], R7>>,\n Function<[Await], R6> | Curry], R6>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n R9,\n P extends any[],\n >(fns: [\n Function<[Await], R9> | Curry], R9>>,\n Function<[Await], R8> | Curry], R8>>,\n Function<[Await], R7> | Curry], R7>>,\n Function<[Await], R6> | Curry], R6>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n}\n" }, { "path": "sources/Function/Compose/List/Sync.ts", "content": "/** @ignore *//** */\n\nimport {Curry} from '../../Curry'\nimport {Function} from '../../Function'\n\n/**\n *@hidden\n */\nexport type ComposeListSync = {\n <\n R0,\n P extends any[],\n >(fns: [\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n P extends any[],\n >(fns: [\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n P extends any[],\n >(fns: [\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n P extends any[],\n >(fns: [\n Function<[R2], R3> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n P extends any[],\n >(fns: [\n Function<[R3], R4> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n P extends any[],\n >(fns: [\n Function<[R4], R5> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n P extends any[],\n >(fns: [\n Function<[R5], R6> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n P extends any[],\n >(fns: [\n Function<[R6], R7> | Curry>,\n Function<[R5], R6> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n P extends any[],\n >(fns: [\n Function<[R7], R8> | Curry>,\n Function<[R6], R7> | Curry>,\n Function<[R5], R6> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n R9,\n P extends any[],\n >(fns: [\n Function<[R8], R9> | Curry>,\n Function<[R7], R8> | Curry>,\n Function<[R6], R7> | Curry>,\n Function<[R5], R6> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n}\n" }, { "path": "sources/Function/Compose/Multi/Async.ts", "content": "/** @ignore *//** */\n\nimport {Function} from '../../Function'\nimport {Await} from '../../../Any/Await'\nimport {Curry} from '../../Curry'\n\n/**\n *@hidden\n */\nexport type ComposeMultiAsync = {\n <\n R0,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n P extends any[],\n >(...fns: [\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n P extends any[],\n >(...fns: [\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n P extends any[],\n >(...fns: [\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n P extends any[],\n >(...fns: [\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n P extends any[],\n >(...fns: [\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n P extends any[],\n >(...fns: [\n Function<[Await], R6> | Curry], R6>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n P extends any[],\n >(...fns: [\n Function<[Await], R7> | Curry], R7>>,\n Function<[Await], R6> | Curry], R6>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n P extends any[],\n >(...fns: [\n Function<[Await], R8> | Curry], R8>>,\n Function<[Await], R7> | Curry], R7>>,\n Function<[Await], R6> | Curry], R6>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n R9,\n P extends any[],\n >(...fns: [\n Function<[Await], R9> | Curry], R9>>,\n Function<[Await], R8> | Curry], R8>>,\n Function<[Await], R7> | Curry], R7>>,\n Function<[Await], R6> | Curry], R6>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R1> | Curry], R1>>,\n Function | Curry>,\n ]): Function>>\n}\n" }, { "path": "sources/Function/Compose/Multi/Sync.ts", "content": "\n/** @ignore *//** */\n\nimport {Curry} from '../../Curry'\nimport {Function} from '../../Function'\n\n/**\n *@hidden\n */\nexport type ComposeMultiSync = {\n <\n R0,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n P extends any[],\n >(...fns: [\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n P extends any[],\n >(...fns: [\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n P extends any[],\n >(...fns: [\n Function<[R2], R3> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n P extends any[],\n >(...fns: [\n Function<[R3], R4> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n P extends any[],\n >(...fns: [\n Function<[R4], R5> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n P extends any[],\n >(...fns: [\n Function<[R5], R6> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n P extends any[],\n >(...fns: [\n Function<[R6], R7> | Curry>,\n Function<[R5], R6> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n P extends any[],\n >(...fns: [\n Function<[R7], R8> | Curry>,\n Function<[R6], R7> | Curry>,\n Function<[R5], R6> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n R9,\n P extends any[],\n >(...fns: [\n Function<[R8], R9> | Curry>,\n Function<[R7], R8> | Curry>,\n Function<[R6], R7> | Curry>,\n Function<[R5], R6> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R0], R1> | Curry>,\n Function | Curry>,\n ]): Function\n}\n" }, { "path": "sources/Function/Compose.ts", "content": "import {IntersectOf} from '../Union/IntersectOf'\nimport {ComposeListAsync} from './Compose/List/Async'\nimport {ComposeListSync} from './Compose/List/Sync'\nimport {ComposeMultiAsync} from './Compose/Multi/Async'\nimport {ComposeMultiSync} from './Compose/Multi/Sync'\nimport {Input, Mode} from './_Internal'\n\n/**\n * Compose [[Function]]s together\n * @param mode (?=`'sync'`) sync/async (this depends on your implementation)\n * @param input (?=`'multi'`) whether you want it to take a list or parameters\n * @example\n * ```ts\n * import {F} from 'ts-toolbelt'\n *\n * /// If you are looking for creating types for `compose`\n * /// `Composer` will check for input & `Compose` the output\n * declare const compose: F.Compose\n *\n * const a = (a1: number) => `${a1}`\n * const c = (c1: string[]) => [c1]\n * const b = (b1: string) => [b1]\n *\n * compose(c, b, a)(42)\n *\n * /// And if you are looking for an async `compose` type\n * declare const compose: F.Compose<'async'>\n *\n * const a = async (a1: number) => `${a1}`\n * const b = async (b1: string) => [b1]\n * const c = async (c1: string[]) => [c1]\n *\n * await compose(c, b, a)(42)\n */\nexport type Compose = IntersectOf<{\n 'sync' : {\n 'multi': ComposeMultiSync\n 'list' : ComposeListSync\n }\n 'async': {\n 'multi': ComposeMultiAsync\n 'list' : ComposeListAsync\n }\n}[mode][input]> // `IntersectOf` in case of unions\n" }, { "path": "sources/Function/Curry.ts", "content": "import {Pos} from '../Iteration/Pos'\nimport {Concat} from '../List/Concat'\nimport {Length} from '../List/Length'\nimport {Next} from '../Iteration/Next'\nimport {Cast} from '../Any/Cast'\nimport {Parameters} from './Parameters'\nimport {Return} from './Return'\nimport {IterationOf} from '../Iteration/IterationOf'\nimport {Iteration} from '../Iteration/Iteration'\nimport {NonNullableFlat} from '../Object/NonNullable'\nimport {x} from '../Any/x'\nimport {List} from '../List/List'\nimport {Function} from './Function'\nimport {Extends} from '../Any/Extends'\nimport {Tail} from '../List/Tail'\nimport {RequiredKeys} from '../List/RequiredKeys'\n\n/**\n * @hidden\n */\ntype _SplitParams

> = {\n 0: P extends [...infer A, ...PRest]\n ? _SplitParams, [...PSplit, A], Tail>\n : never\n 1: PSplit\n 2: P[number][][]\n}[\n number extends Length

\n ? 2\n : P extends []\n ? 1\n : 0\n]\n\n/**\n * Splits tuples to preserve their labels\n * @hidden\n */\ntype SplitParams

=\n _SplitParams

extends infer X\n ? Cast\n : never\n\n/**\n * @hidden\n */\ntype _JoinParams = {\n 0: _JoinParams, [...L, ...PSplit[0]]>\n 1: L\n 2: PSplit[number][]\n}[\n number extends Length\n ? 2\n : PSplit extends []\n ? 1\n : 0\n]\n\n/**\n * Undoes the job of [[SplitParams]]\n * @hidden\n */\ntype JoinParams

=\n _JoinParams

extends infer X\n ? Cast\n : never\n\n/**\n * @hidden\n */\ntype GapOf =\n L1[Pos] extends x\n ? Concat]>\n : LN\n\n/**\n * @hidden\n */\ntype _GapsOf> = {\n 0: _GapsOf, Tail, Next>\n 1: Concat>\n}[Extends, Length>]\n\n/**\n * @hidden\n */\ntype GapsOf =\n _GapsOf> extends infer X\n ? Cast\n : never\n\n/**\n * @hidden\n */\ntype Gaps = Cast, List>\n\n/**\n * Curry a [[Function]]\n * @param F to curry\n * @returns [[Function]]\n * @example\n * ```ts\n * import {F} from 'ts-toolbelt'\n *\n * /// If you are looking for creating types for `curry`\n * /// It handles placeholders and variable arguments\n * declare function curry(fn: Fn): F.Curry\n * ```\n */\nexport type Curry =\n <\n P extends Gaps>,\n G extends List = GapsOf>,\n R extends any = Return\n >(...p: Gaps> | P) =>\n // handles optional parameters\n RequiredKeys extends never\n ? R\n : Curry<(...p: G) => R>\n" }, { "path": "sources/Function/Exact.ts", "content": "import {Narrowable} from './_Internal'\n\n/**\n * Force `A` to comply with `W`. `A` must be a shape of `W`. In other words, `A`\n * must extend `W` and have the same properties - no more, no less.\n * @param A\n * @param W\n */\ntype Exact =\nW extends unknown ?\n A extends W\n ? A extends Narrowable\n ? A\n : {\n [K in keyof A]: K extends keyof W\n ? Exact\n : never\n }\n : W\n: never;\n\nexport {Exact}\n" }, { "path": "sources/Function/Function.ts", "content": "import {List} from '../List/List'\n\n/**\n * Alias to create a [[Function]]\n * @param P parameters\n * @param R return type\n * @returns [[Function]]\n * @example\n * ```ts\n * import {F} from 'ts-toolbelt'\n *\n * type test0 = F.Function<[string, number], boolean>\n * /// (args_0: string, args_1: number) => boolean\n * ```\n */\nexport type Function

=\n (...args: P) => R\n" }, { "path": "sources/Function/Length.ts", "content": "import {Function} from './Function'\nimport {Parameters} from './Parameters'\nimport {Length as LLength} from '../List/Length'\n\n/**\n * Extract arguments' length from a [[Function]]\n * @param F to extract from\n * @returns [[String]] or `number`\n * @example\n * ```ts\n * import {F} from 'ts-toolbelt'\n *\n * const fn = (a1: any, a2: any) => {}\n *\n * type test0 = F.LengthOf // 2\n *\n * type test1 = F.LengthOf<(a1?: any) => any> // 0 | 1\n *\n * type test2 = F.LengthOf<(...a: any[]) => any> // number\n * ```\n */\nexport type Length =\n LLength>\n" }, { "path": "sources/Function/Narrow.ts", "content": "import {Try} from '../Any/Try'\nimport {Narrowable} from './_Internal'\n\n/**\n * @hidden\n */\ntype NarrowRaw =\n| (A extends [] ? [] : never)\n| (A extends Narrowable ? A : never)\n| ({[K in keyof A]: A[K] extends Function\n ? A[K]\n : NarrowRaw});\n\n/**\n * Prevent type widening on generic function parameters\n * @param A to narrow\n * @returns `A`\n * @example\n * ```ts\n * import {F} from 'ts-toolbelt'\n *\n * declare function foo(x: F.Narrow): A;\n * declare function bar(x: F.Narrow): A;\n *\n * const test0 = foo(['e', 2, true, {f: ['g', ['h']]}])\n * // `A` inferred : ['e', 2, true, {f: ['g']}]\n *\n * const test1 = bar({a: 1, b: 'c', d: ['e', 2, true, {f: ['g']}]})\n * // `A` inferred : {a: 1, b: 'c', d: ['e', 2, true, {f: ['g']}]}\n * ```\n */\ntype Narrow =\n Try>\n\nexport {Narrow}\n" }, { "path": "sources/Function/NoInfer.ts", "content": "/**\n * Explain to TS which function parameter has priority for generic inference\n * @param A to de-prioritize\n * @returns `A`\n * @example\n * ```ts\n * import {F} from 'ts-toolbelt'\n *\n * const fn0 = (a0: A, a1: F.NoInfer): A => {\n * return {} as unknown as A // just for the example\n * }\n *\n * const fn1 = (a0: F.NoInfer, a1: A): A => {\n * return {} as unknown as A // just for the example\n * }\n *\n * const fn2 = (a0: F.NoInfer, a1: F.NoInfer): A => {\n * return {} as unknown as A // just for the example\n * }\n *\n * const test0 = fn0('b', 'a') // error: infer priority is `a0`\n * const test1 = fn1('b', 'a') // error: infer priority is `a1`\n * const test2 = fn2('b', 'a') // works: infer priority is `a0` | `a1`\n * ```\n * @see https://stackoverflow.com/questions/56687668\n */\nexport type NoInfer =\n [A][A extends any ? 0 : never]\n\n/*\n * https://github.com/microsoft/TypeScript/issues/14829#issuecomment-322267089\n * https://stackoverflow.com/questions/56687668\n */\n\n\n" }, { "path": "sources/Function/Parameters.ts", "content": "import {Function} from './Function'\n\n/**\n * Extract parameters from a [[Function]]\n * @param F to extract from\n * @returns [[List]]\n * @example\n * ```ts\n * import {F} from 'ts-toolbelt'\n *\n * const fn = (name: string, age: number) => {}\n *\n * type test0 = F.ParamsOf // [string, number]\n *\n * type test1 = F.ParamsOf<(name: string, age: number) => {}> // [string, number]\n * ```\n */\nexport type Parameters =\n F extends ((...args: infer L) => any)\n ? L\n : never\n" }, { "path": "sources/Function/Pipe/List/Async.ts", "content": "/** @ignore *//** */\nimport {Function} from '../../Function'\nimport {Await} from '../../../Any/Await'\nimport {Curry} from '../../Curry'\n\n/**\n *@hidden\n */\nexport type PipeListAsync = {\n <\n R0,\n P extends any[],\n >(fns: [\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R3> | Curry], R3>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R4> | Curry], R4>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R5> | Curry], R5>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R6> | Curry], R6>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R6> | Curry], R6>>,\n Function<[Await], R7> | Curry], R7>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R6> | Curry], R6>>,\n Function<[Await], R7> | Curry], R7>>,\n Function<[Await], R8> | Curry], R8>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n R9,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R6> | Curry], R6>>,\n Function<[Await], R7> | Curry], R7>>,\n Function<[Await], R8> | Curry], R8>>,\n Function<[Await], R9> | Curry], R9>>,\n ]): Function>>\n}\n" }, { "path": "sources/Function/Pipe/List/Sync.ts", "content": "/** @ignore *//** */\n\nimport {Curry} from '../../Curry'\nimport {Function} from '../../Function'\n\n/**\n *@hidden\n */\nexport type PipeListSync = {\n <\n R0,\n P extends any[],\n >(fns: [\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R2], R3> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R3], R4> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R4], R5> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R5], R6> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R5], R6> | Curry>,\n Function<[R6], R7> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R5], R6> | Curry>,\n Function<[R6], R7> | Curry>,\n Function<[R7], R8> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n R9,\n P extends any[],\n >(fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R5], R6> | Curry>,\n Function<[R6], R7> | Curry>,\n Function<[R7], R8> | Curry>,\n Function<[R8], R9> | Curry>,\n ]): Function\n}\n" }, { "path": "sources/Function/Pipe/Multi/Async.ts", "content": "/** @ignore *//** */\n\nimport {Function} from '../../Function'\nimport {Await} from '../../../Any/Await'\nimport {Curry} from '../../Curry'\n\n/**\n *@hidden\n */\nexport type PipeMultiAsync = {\n <\n R0,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n ]): Function>>\n\n <\n R0,\n R1,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R3> | Curry], R3>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R4> | Curry], R4>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R5> | Curry], R5>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R6> | Curry], R6>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R6> | Curry], R6>>,\n Function<[Await], R7> | Curry], R7>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R6> | Curry], R6>>,\n Function<[Await], R7> | Curry], R7>>,\n Function<[Await], R8> | Curry], R8>>,\n ]): Function>>\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n R9,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[Await], R1> | Curry], R1>>,\n Function<[Await], R2> | Curry], R2>>,\n Function<[Await], R3> | Curry], R3>>,\n Function<[Await], R4> | Curry], R4>>,\n Function<[Await], R5> | Curry], R5>>,\n Function<[Await], R6> | Curry], R6>>,\n Function<[Await], R7> | Curry], R7>>,\n Function<[Await], R8> | Curry], R8>>,\n Function<[Await], R9> | Curry], R9>>,\n ]): Function>>\n}\n" }, { "path": "sources/Function/Pipe/Multi/Sync.ts", "content": "/** @ignore *//** */\n\nimport {Curry} from '../../Curry'\nimport {Function} from '../../Function'\n\n/**\n *@hidden\n */\nexport type PipeMultiSync = {\n <\n R0,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R2], R3> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R3], R4> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R4], R5> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R5], R6> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R5], R6> | Curry>,\n Function<[R6], R7> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R5], R6> | Curry>,\n Function<[R6], R7> | Curry>,\n Function<[R7], R8> | Curry>,\n ]): Function\n\n <\n R0,\n R1,\n R2,\n R3,\n R4,\n R5,\n R6,\n R7,\n R8,\n R9,\n P extends any[],\n >(...fns: [\n Function | Curry>,\n Function<[R0], R1> | Curry>,\n Function<[R1], R2> | Curry>,\n Function<[R2], R3> | Curry>,\n Function<[R3], R4> | Curry>,\n Function<[R4], R5> | Curry>,\n Function<[R5], R6> | Curry>,\n Function<[R6], R7> | Curry>,\n Function<[R7], R8> | Curry>,\n Function<[R8], R9> | Curry>,\n ]): Function\n}\n" }, { "path": "sources/Function/Pipe.ts", "content": "import {IntersectOf} from '../Union/IntersectOf'\nimport {PipeListAsync} from './Pipe/List/Async'\nimport {PipeListSync} from './Pipe/List/Sync'\nimport {PipeMultiAsync} from './Pipe/Multi/Async'\nimport {PipeMultiSync} from './Pipe/Multi/Sync'\nimport {Input, Mode} from './_Internal'\n\n/**\n * Pipe [[Function]]s together\n * @param mode (?=`'sync'`) sync/async (this depends on your implementation)\n * @param input (?=`'multi'`) whether you want to take a list or multiple parameters\n * @returns [[Function]]\n * @example\n * ```ts\n * import {F} from 'ts-toolbelt'\n *\n * /// If you are looking for creating types for `pipe`:\n * declare const pipe: F.Pipe\n *\n * const a = (a1: number) => `${a1}`\n * const b = (b1: string) => [b1]\n * const c = (c1: string[]) => [c1]\n *\n * pipe(a, b, c)(42)\n *\n * /// And if you are looking for an async `pipe` type:\n * declare const pipe: F.Pipe<'async'>\n *\n * const a = async (a1: number) => `${a1}`\n * const b = async (b1: string) => [b1]\n * const c = async (c1: string[]) => [c1]\n *\n * await pipe(a, b, c)(42)\n * ```\n */\nexport type Pipe = IntersectOf<{\n 'sync' : {\n 'multi': PipeMultiSync\n 'list' : PipeListSync\n }\n 'async': {\n 'multi': PipeMultiAsync\n 'list' : PipeListAsync\n }\n}[mode][input]> // `IntersectOf` in case of unions\n" }, { "path": "sources/Function/Promisify.ts", "content": "import {Function} from './Function'\nimport {Parameters} from './Parameters'\nimport {Return} from './Return'\nimport {Promise} from '../Any/Promise'\n\n/**\n * Creates a promisified version of a `Function` `F`\n * @param F to promisify\n * @returns async F\n * @example\n * ```ts\n * import {F} from 'ts-toolbelt'\n *\n * type test0 = F.Promisify<(a: number) => number> // (a: number) => Promise\n * ```\n */\nexport type Promisify =\n (...args: Parameters) => Promise>\n" }, { "path": "sources/Function/Return.ts", "content": "import {Function} from './Function'\nimport {List} from '../List/List'\n\n/**\n * Extract the return type of a [[Function]]\n * @param F to extract from\n * @returns [[Any]]\n * @example\n * ```ts\n * import {F} from 'ts-toolbelt'\n *\n * const fn = () => true\n *\n * type test0 = F.ReturnOf // boolean\n *\n * type test1 = F.ReturnOf<() => true> // true\n * ```\n */\nexport type Return =\n F extends ((...args: List) => infer R)\n ? R\n : never\n" }, { "path": "sources/Function/UnCurry.ts", "content": "import {Curry} from './Curry'\n\n/**\n * Undoes the work that was done by [[Curry]]\n * @param F to uncurry\n * @returns [[Function]]\n * @example\n * ```ts\n * import {F} from 'ts-toolbelt'\n *\n * type test0 = F.Curry<(a: string, b: number) => boolean>\n * declare const foo: test0\n * const res0 = foo('a') // F.Curry<(b: number) => boolean> & ((b: number) => boolean)\n *\n * type test1 = F.UnCurry // (a: string, b: number) => boolean\n * declare const bar: test1\n * const res1 = bar('a') // TS2554: Expected 2 arguments, but got 1.\n * ```\n * @ignore\n */\nexport type UnCurry> =\n F extends Curry\n ? UF\n : never\n" }, { "path": "sources/Function/ValidPath.ts", "content": "import {IterationOf} from '../Iteration/IterationOf'\nimport {Iteration} from '../Iteration/Iteration'\nimport {Next} from '../Iteration/Next'\nimport {Pos} from '../Iteration/Pos'\nimport {At} from '../Any/At'\nimport {Cast} from '../Any/Cast'\nimport {NonNullable} from '../Union/NonNullable'\nimport {Update} from '../List/Update'\nimport {Key} from '../Iteration/Key'\nimport {Key as AKey} from '../Any/Key'\nimport {List} from '../List/List'\nimport {Length} from '../List/Length'\nimport {Extends} from '../Any/Extends'\n\n/**\n * @hidden\n */\ntype ValidatePath, I extends Iteration> =\n Update<\n Path,\n Key,\n [At]>] extends [never]\n ? keyof O\n : Path[Pos]\n >\n\n/**\n * @hidden\n */\ntype __ValidPath, I extends Iteration = IterationOf<0>> = {\n 0: __ValidPath]>>, ValidatePath, Next>\n 1: Path\n}[Extends, Length>]\n\n/**\n * @hidden\n */\nexport type _ValidPath> =\n __ValidPath extends infer X\n ? Cast>\n : never\n\n/**\n * Replaces invalid parts of a path with `never`\n * @param O to be inspected\n * @param Path to be validated\n * @returns [[Index]][]\n * @example\n * ```ts\n * import {A, L, O} from 'ts-toolbelt'\n *\n * // Get a property in an object `o` at any depth with `path`\n * // `A.Cast>` makes sure `path` is valid\n * const getAt = <\n * O extends object,\n * P extends L.List\n * >(o: O, path: A.Cast>): O.Path => {\n * let valueAt = o\n *\n * for (const p of path)\n * valueAt = valueAt[p]\n *\n * return valueAt as any\n * }\n *\n * const test0 = getAt({a: {b: {c: 1}}}, ['a', 'b'] as const) // {c: number}\n * const test1 = getAt({a: {b: {c: 1}}} as const, ['a', 'b'] as const) // {c: 1}\n * const test2 = getAt({a: {b: {c: 1}}}, ['x'] as const) // error\n * ```\n */\nexport type ValidPath> =\n O extends unknown\n ? Path extends unknown\n ? _ValidPath\n : never\n : never\n" }, { "path": "sources/Function/_Internal.ts", "content": "/**\n * Describes function modes\n * `sync` : Normal function\n * `async`: Promised result\n */\nexport type Mode = 'sync' | 'async'\n\n/**\n * Describes function parameter input\n * `multi`: ( a, b, c ... n ) => X\n * `list` : ([a, b, c ... n]) => X\n */\nexport type Input = 'multi' | 'list'\n\n/**\n * Describes types that can be narrowed\n */\nexport type Narrowable =\n| string\n| number\n| bigint\n| boolean\n" }, { "path": "sources/Function/_api.ts", "content": "/** @ignore *//** */\n\nexport {AutoPath} from './AutoPath'\nexport {Compose} from './Compose'\nexport {Exact} from './Exact'\nexport {Curry} from './Curry'\nexport {Function} from './Function'\nexport {Narrow} from './Narrow'\nexport {Length} from './Length'\nexport {NoInfer} from './NoInfer'\nexport {Parameters} from './Parameters'\nexport {Pipe} from './Pipe'\nexport {Promisify} from './Promisify'\nexport {Return} from './Return'\nexport {UnCurry} from './UnCurry'\nexport {ValidPath} from './ValidPath'\n" }, { "path": "sources/Iteration/Iteration.ts", "content": "/**\n * An entry of `IterationMap`\n */\nexport type Iteration = [\n value: number,\n sign: '-' | '0' | '+',\n prev: keyof IterationMap,\n next: keyof IterationMap,\n oppo: keyof IterationMap,\n]\n\nexport type IterationMap = {\n '__': [number, '-' | '0' | '+', '__', '__', '__'],\n '-100': [-100, '-', '__', '-99', '100'],\n '-99': [-99, '-', '-100', '-98', '99'],\n '-98': [-98, '-', '-99', '-97', '98'],\n '-97': [-97, '-', '-98', '-96', '97'],\n '-96': [-96, '-', '-97', '-95', '96'],\n '-95': [-95, '-', '-96', '-94', '95'],\n '-94': [-94, '-', '-95', '-93', '94'],\n '-93': [-93, '-', '-94', '-92', '93'],\n '-92': [-92, '-', '-93', '-91', '92'],\n '-91': [-91, '-', '-92', '-90', '91'],\n '-90': [-90, '-', '-91', '-89', '90'],\n '-89': [-89, '-', '-90', '-88', '89'],\n '-88': [-88, '-', '-89', '-87', '88'],\n '-87': [-87, '-', '-88', '-86', '87'],\n '-86': [-86, '-', '-87', '-85', '86'],\n '-85': [-85, '-', '-86', '-84', '85'],\n '-84': [-84, '-', '-85', '-83', '84'],\n '-83': [-83, '-', '-84', '-82', '83'],\n '-82': [-82, '-', '-83', '-81', '82'],\n '-81': [-81, '-', '-82', '-80', '81'],\n '-80': [-80, '-', '-81', '-79', '80'],\n '-79': [-79, '-', '-80', '-78', '79'],\n '-78': [-78, '-', '-79', '-77', '78'],\n '-77': [-77, '-', '-78', '-76', '77'],\n '-76': [-76, '-', '-77', '-75', '76'],\n '-75': [-75, '-', '-76', '-74', '75'],\n '-74': [-74, '-', '-75', '-73', '74'],\n '-73': [-73, '-', '-74', '-72', '73'],\n '-72': [-72, '-', '-73', '-71', '72'],\n '-71': [-71, '-', '-72', '-70', '71'],\n '-70': [-70, '-', '-71', '-69', '70'],\n '-69': [-69, '-', '-70', '-68', '69'],\n '-68': [-68, '-', '-69', '-67', '68'],\n '-67': [-67, '-', '-68', '-66', '67'],\n '-66': [-66, '-', '-67', '-65', '66'],\n '-65': [-65, '-', '-66', '-64', '65'],\n '-64': [-64, '-', '-65', '-63', '64'],\n '-63': [-63, '-', '-64', '-62', '63'],\n '-62': [-62, '-', '-63', '-61', '62'],\n '-61': [-61, '-', '-62', '-60', '61'],\n '-60': [-60, '-', '-61', '-59', '60'],\n '-59': [-59, '-', '-60', '-58', '59'],\n '-58': [-58, '-', '-59', '-57', '58'],\n '-57': [-57, '-', '-58', '-56', '57'],\n '-56': [-56, '-', '-57', '-55', '56'],\n '-55': [-55, '-', '-56', '-54', '55'],\n '-54': [-54, '-', '-55', '-53', '54'],\n '-53': [-53, '-', '-54', '-52', '53'],\n '-52': [-52, '-', '-53', '-51', '52'],\n '-51': [-51, '-', '-52', '-50', '51'],\n '-50': [-50, '-', '-51', '-49', '50'],\n '-49': [-49, '-', '-50', '-48', '49'],\n '-48': [-48, '-', '-49', '-47', '48'],\n '-47': [-47, '-', '-48', '-46', '47'],\n '-46': [-46, '-', '-47', '-45', '46'],\n '-45': [-45, '-', '-46', '-44', '45'],\n '-44': [-44, '-', '-45', '-43', '44'],\n '-43': [-43, '-', '-44', '-42', '43'],\n '-42': [-42, '-', '-43', '-41', '42'],\n '-41': [-41, '-', '-42', '-40', '41'],\n '-40': [-40, '-', '-41', '-39', '40'],\n '-39': [-39, '-', '-40', '-38', '39'],\n '-38': [-38, '-', '-39', '-37', '38'],\n '-37': [-37, '-', '-38', '-36', '37'],\n '-36': [-36, '-', '-37', '-35', '36'],\n '-35': [-35, '-', '-36', '-34', '35'],\n '-34': [-34, '-', '-35', '-33', '34'],\n '-33': [-33, '-', '-34', '-32', '33'],\n '-32': [-32, '-', '-33', '-31', '32'],\n '-31': [-31, '-', '-32', '-30', '31'],\n '-30': [-30, '-', '-31', '-29', '30'],\n '-29': [-29, '-', '-30', '-28', '29'],\n '-28': [-28, '-', '-29', '-27', '28'],\n '-27': [-27, '-', '-28', '-26', '27'],\n '-26': [-26, '-', '-27', '-25', '26'],\n '-25': [-25, '-', '-26', '-24', '25'],\n '-24': [-24, '-', '-25', '-23', '24'],\n '-23': [-23, '-', '-24', '-22', '23'],\n '-22': [-22, '-', '-23', '-21', '22'],\n '-21': [-21, '-', '-22', '-20', '21'],\n '-20': [-20, '-', '-21', '-19', '20'],\n '-19': [-19, '-', '-20', '-18', '19'],\n '-18': [-18, '-', '-19', '-17', '18'],\n '-17': [-17, '-', '-18', '-16', '17'],\n '-16': [-16, '-', '-17', '-15', '16'],\n '-15': [-15, '-', '-16', '-14', '15'],\n '-14': [-14, '-', '-15', '-13', '14'],\n '-13': [-13, '-', '-14', '-12', '13'],\n '-12': [-12, '-', '-13', '-11', '12'],\n '-11': [-11, '-', '-12', '-10', '11'],\n '-10': [-10, '-', '-11', '-9', '10'],\n '-9': [-9, '-', '-10', '-8', '9'],\n '-8': [-8, '-', '-9', '-7', '8'],\n '-7': [-7, '-', '-8', '-6', '7'],\n '-6': [-6, '-', '-7', '-5', '6'],\n '-5': [-5, '-', '-6', '-4', '5'],\n '-4': [-4, '-', '-5', '-3', '4'],\n '-3': [-3, '-', '-4', '-2', '3'],\n '-2': [-2, '-', '-3', '-1', '2'],\n '-1': [-1, '-', '-2', '0', '1'],\n '0': [0, '0', '-1', '1', '0'],\n '1': [1, '+', '0', '2', '-1'],\n '2': [2, '+', '1', '3', '-2'],\n '3': [3, '+', '2', '4', '-3'],\n '4': [4, '+', '3', '5', '-4'],\n '5': [5, '+', '4', '6', '-5'],\n '6': [6, '+', '5', '7', '-6'],\n '7': [7, '+', '6', '8', '-7'],\n '8': [8, '+', '7', '9', '-8'],\n '9': [9, '+', '8', '10', '-9'],\n '10': [10, '+', '9', '11', '-10'],\n '11': [11, '+', '10', '12', '-11'],\n '12': [12, '+', '11', '13', '-12'],\n '13': [13, '+', '12', '14', '-13'],\n '14': [14, '+', '13', '15', '-14'],\n '15': [15, '+', '14', '16', '-15'],\n '16': [16, '+', '15', '17', '-16'],\n '17': [17, '+', '16', '18', '-17'],\n '18': [18, '+', '17', '19', '-18'],\n '19': [19, '+', '18', '20', '-19'],\n '20': [20, '+', '19', '21', '-20'],\n '21': [21, '+', '20', '22', '-21'],\n '22': [22, '+', '21', '23', '-22'],\n '23': [23, '+', '22', '24', '-23'],\n '24': [24, '+', '23', '25', '-24'],\n '25': [25, '+', '24', '26', '-25'],\n '26': [26, '+', '25', '27', '-26'],\n '27': [27, '+', '26', '28', '-27'],\n '28': [28, '+', '27', '29', '-28'],\n '29': [29, '+', '28', '30', '-29'],\n '30': [30, '+', '29', '31', '-30'],\n '31': [31, '+', '30', '32', '-31'],\n '32': [32, '+', '31', '33', '-32'],\n '33': [33, '+', '32', '34', '-33'],\n '34': [34, '+', '33', '35', '-34'],\n '35': [35, '+', '34', '36', '-35'],\n '36': [36, '+', '35', '37', '-36'],\n '37': [37, '+', '36', '38', '-37'],\n '38': [38, '+', '37', '39', '-38'],\n '39': [39, '+', '38', '40', '-39'],\n '40': [40, '+', '39', '41', '-40'],\n '41': [41, '+', '40', '42', '-41'],\n '42': [42, '+', '41', '43', '-42'],\n '43': [43, '+', '42', '44', '-43'],\n '44': [44, '+', '43', '45', '-44'],\n '45': [45, '+', '44', '46', '-45'],\n '46': [46, '+', '45', '47', '-46'],\n '47': [47, '+', '46', '48', '-47'],\n '48': [48, '+', '47', '49', '-48'],\n '49': [49, '+', '48', '50', '-49'],\n '50': [50, '+', '49', '51', '-50'],\n '51': [51, '+', '50', '52', '-51'],\n '52': [52, '+', '51', '53', '-52'],\n '53': [53, '+', '52', '54', '-53'],\n '54': [54, '+', '53', '55', '-54'],\n '55': [55, '+', '54', '56', '-55'],\n '56': [56, '+', '55', '57', '-56'],\n '57': [57, '+', '56', '58', '-57'],\n '58': [58, '+', '57', '59', '-58'],\n '59': [59, '+', '58', '60', '-59'],\n '60': [60, '+', '59', '61', '-60'],\n '61': [61, '+', '60', '62', '-61'],\n '62': [62, '+', '61', '63', '-62'],\n '63': [63, '+', '62', '64', '-63'],\n '64': [64, '+', '63', '65', '-64'],\n '65': [65, '+', '64', '66', '-65'],\n '66': [66, '+', '65', '67', '-66'],\n '67': [67, '+', '66', '68', '-67'],\n '68': [68, '+', '67', '69', '-68'],\n '69': [69, '+', '68', '70', '-69'],\n '70': [70, '+', '69', '71', '-70'],\n '71': [71, '+', '70', '72', '-71'],\n '72': [72, '+', '71', '73', '-72'],\n '73': [73, '+', '72', '74', '-73'],\n '74': [74, '+', '73', '75', '-74'],\n '75': [75, '+', '74', '76', '-75'],\n '76': [76, '+', '75', '77', '-76'],\n '77': [77, '+', '76', '78', '-77'],\n '78': [78, '+', '77', '79', '-78'],\n '79': [79, '+', '78', '80', '-79'],\n '80': [80, '+', '79', '81', '-80'],\n '81': [81, '+', '80', '82', '-81'],\n '82': [82, '+', '81', '83', '-82'],\n '83': [83, '+', '82', '84', '-83'],\n '84': [84, '+', '83', '85', '-84'],\n '85': [85, '+', '84', '86', '-85'],\n '86': [86, '+', '85', '87', '-86'],\n '87': [87, '+', '86', '88', '-87'],\n '88': [88, '+', '87', '89', '-88'],\n '89': [89, '+', '88', '90', '-89'],\n '90': [90, '+', '89', '91', '-90'],\n '91': [91, '+', '90', '92', '-91'],\n '92': [92, '+', '91', '93', '-92'],\n '93': [93, '+', '92', '94', '-93'],\n '94': [94, '+', '93', '95', '-94'],\n '95': [95, '+', '94', '96', '-95'],\n '96': [96, '+', '95', '97', '-96'],\n '97': [97, '+', '96', '98', '-97'],\n '98': [98, '+', '97', '99', '-98'],\n '99': [99, '+', '98', '100', '-99'],\n '100': [100, '+', '99', '__', '-100'],\n}\n" }, { "path": "sources/Iteration/IterationOf.ts", "content": "import {IterationMap} from './Iteration'\n\n/**\n * Transform a number into an [[Iteration]]\n * (to use [[Prev]], [[Next]], & [[Pos]])\n * @param N to transform\n * @returns [[Iteration]]\n * @example\n * ```ts\n * import {I} from 'ts-toolbelt'\n *\n * type i = I.IterationOf<0> // [\"-1\", \"1\", \"0\", 0, \"0\"]\n *\n * type next = I.Next // [\"0\", \"2\", \"1\", 1, \"+\"]\n * type prev = I.Prev // [\"-2\", \"0\", \"-1\", -1, \"-\"]\n *\n * type nnext = I.Pos // +1\n * type nprev = I.Pos // -1\n * ```\n */\nexport type IterationOf =\n `${N}` extends keyof IterationMap\n ? IterationMap[`${N}`]\n : IterationMap['__']\n" }, { "path": "sources/Iteration/Key.ts", "content": "import {Iteration} from './Iteration'\n\n/**\n * Get the position of `I` (**string**)\n * @param I to query\n * @returns [[String]]\n * @example\n * ```ts\n * import {I} from 'ts-toolbelt'\n *\n * type i = I.IterationOf<'20'>\n *\n * type test0 = I.Key // '20'\n * type test1 = I.Key> // '21'\n * ```\n */\nexport type Key =\n `${I[0]}`\n" }, { "path": "sources/Iteration/Next.ts", "content": "import {Iteration, IterationMap} from './Iteration'\n\n/**\n * Move `I`'s position forward\n * @param I to move\n * @returns [[Iteration]]\n * @example\n * ```ts\n * import {I} from 'ts-toolbelt'\n *\n * type i = I.IterationOf<'20'>\n *\n * type test0 = I.Pos // 20\n * type test1 = I.Pos> // 21\n * ```\n */\nexport type Next =\n IterationMap[I[3]]\n" }, { "path": "sources/Iteration/Pos.ts", "content": "import {Iteration} from './Iteration'\n\n/**\n * Get the position of `I` (**number**)\n * @param I to query\n * @returns `number`\n * @example\n * ```ts\n * import {I} from 'ts-toolbelt'\n *\n * type i = I.IterationOf<'20'>\n *\n * type test0 = I.Pos // 20\n * type test1 = I.Pos> // 21\n * ```\n */\nexport type Pos =\n I[0]\n" }, { "path": "sources/Iteration/Prev.ts", "content": "\nimport {Iteration, IterationMap} from './Iteration'\n/**\n * Move `I`'s position backwards\n * @param I to move\n * @returns [[Iteration]]\n * @example\n * ```ts\n * import {I} from 'ts-toolbelt'\n *\n * type i = I.IterationOf<'20'>\n *\n * type test0 = I.Pos // 20\n * type test1 = I.Pos> // 19\n * ```\n */\nexport type Prev =\n IterationMap[I[2]] // continues iterating\n" }, { "path": "sources/Iteration/_Internal.ts", "content": "/**\n * Describes how to perform iterations\n */\nexport type Way = '->' | '<-'\n\n// ---------------------------------------------------------------------------------------\n\n/**\n * Generate the [[IterationOf]] type\n * @param min -40\n * @param max +40\n */\nconst IterationOfGenerator = (min: number, max: number) => {\n // eslint-disable-next-line no-nested-ternary\n const sign = (i: number) => `\"${i > 0 ? '+' : i < 0 ? '-' : '0'}\"`\n const prev = (i: number) => `\"${i === min ? '__' : i - 1}\"`\n const next = (i: number) => `\"${i === max ? '__' : i + 1}\"`\n const oppo = (i: number) => `\"${i * -1}\"`\n const entry = (i: number) => `\"${i}\": [${i}, ${sign(i)}, ${prev(i)}, ${next(i)}, ${oppo(i)}],`\n\n console.log(`{${entry(min)}`)\n\n for (let i = min + 1, k = 1; i <= max - 1; i++, k++)\n console.log(entry(i))\n\n console.log(`${entry(max)}}`)\n}\n\nIterationOfGenerator(-100, +100)\n" }, { "path": "sources/Iteration/_api.ts", "content": "/** @ignore *//** */\n\nexport {Iteration} from './Iteration'\nexport {IterationOf} from './IterationOf'\nexport {Key} from './Key'\nexport {Next} from './Next'\nexport {Pos} from './Pos'\nexport {Prev} from './Prev'\n" }, { "path": "sources/List/Append.ts", "content": "import {List} from './List'\n\n/**\n * Add an element `A` at the end of `L`.\n * @param L to append to\n * @param A to be added to\n * @returns [[List]]\n * @example\n * ```ts\n * import {L} from 'ts-toolbelt'\n *\n * type test0 = L.Append<[1, 2, 3], 4> // [1, 2, 3, 4]\n * type test1 = L.Append<[], 'a'> // ['a']\n * type test2 = L.Append // ['a', 'b', 'c']\n * type test3 = L.Append<[1, 2], [3, 4]> // [1, 2, [3, 4]]\n * ```\n */\nexport type Append =\n [...L, A]\n" }, { "path": "sources/List/Assign.ts", "content": "import {Assign as OAssign} from '../Object/Assign'\nimport {List} from './List'\nimport {Depth} from '../Object/_Internal'\nimport {BuiltIn} from '../Misc/BuiltIn'\nimport {Cast} from '../Any/Cast'\n\n/**\n * Assign a list of [[List]] into `L` with [[Merge]]. Merges from left to\n * right, first items get overridden by the next ones (last-in overrides).\n * @param L to assign to\n * @param Ls to assign\n * @param depth (?=`'flat'`) 'deep' to do it deeply\n * @param ignore (?=`BuiltIn`) types not to merge\n * @param fill (?=`undefined`) types of `O` to be replaced with ones of `O1`\n * @returns [[Object]]\n * @example\n * ```ts\n * import {L} from 'ts-toolbelt'\n *\n * type test0 = Assign<[1, 2, 3], [[2, 1]]> // [2, 1, 3]\n * type test1 = Assign<[], [[1, 2, 3, 4], [2, 4, 6]]> // [2, 4, 6, 4]\n * type test2 = Assign<[0, 0, 0, 0, 0], [[0, 1], [0, 2, 0, 4?]]> // [0, 2, 0, 0 | 4, 0]\n * ```\n */\nexport type Assign, depth extends Depth = 'flat', ignore extends object = BuiltIn, fill extends any = never> =\n Cast, List>\n" }, { "path": "sources/List/AtLeast.ts", "content": "import {Key} from './_Internal'\nimport {AtLeast as OAtLeast} from '../Object/AtLeast'\nimport {ObjectOf} from './ObjectOf'\nimport {_ListOf} from '../Object/ListOf'\nimport {List} from './List'\nimport {Keys} from '../Any/Keys'\n\n/**\n * Make that at least one of the keys `K` are required in `L` at a time.\n * @param L to make required\n * @param K (?=`keyof L`) to choose fields\n * @returns [[List]] [[Union]]\n * @example\n * ```ts\n * import {L} from 'ts-toolbelt'\n *\n * type test0 = L.AtLeast<[1, 2, 3], 0> // [1, 2 | undefined, 3 | undefined]\n * type test1 = L.AtLeast<[1, 2, 3], 0 | 1> // [1, 2 | undefined, 3 | undefined] | [1 | undefined, 2, 3 | undefined]\n * type test2 = L.AtLeast<[1, 2, 3]>\n * // | [1, 2, 3]\n * // | [1, 2 | undefined, 3 | undefined]\n * // | [1 | undefined, 2, 3 | undefined]\n * // | [1 | undefined, 2 | undefined, 3]\n * ```\n */\nexport type AtLeast> =\n OAtLeast, `${K & number}` | K> extends infer U\n ? U extends unknown // we distribute over the union\n ? _ListOf // each union member to a list\n : never\n : never\n\ndeclare const sym: unique symbol\n" }, { "path": "sources/List/Compulsory.ts", "content": "import {Depth} from '../Object/_Internal'\nimport {CompulsoryPart} from '../Object/Compulsory'\nimport {List} from './List'\nimport {_Pick} from '../Object/Pick'\nimport {Cast} from '../Any/Cast'\n\n/**\n * Make that `L`'s fields cannot be [[Nullable]] or [[Optional]] (it's like\n * [[Required]] & [[NonNullable]] at once).\n * @param L to make compulsory\n * @param depth (?=`'flat'`) 'deep' to do it deeply\n * @returns [[List]]\n * @example\n * ```ts\n * * import {L} from 'ts-toolbelt'\n *\n * type test0 = L.Compulsory<[1, 2, 3?, 4?]> // [1, 2, 3, 4]\n * type test1 = L.Compulsory<['a', 'b' | undefined, 'c', 'd', 'e' | null]> // ['a', 'b', 'c', 'd', 'e']\n * ```\n */\nexport type Compulsory =\n Cast, List>\n" }, { "path": "sources/List/CompulsoryKeys.ts", "content": "import {CompulsoryKeys as OCompulsoryKeys} from '../Object/CompulsoryKeys'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Get the keys of `L` that are [[Compulsory]]\n *\n * (โš ๏ธ needs `--strictNullChecks` enabled)\n * @param L\n * @returns [[Key]]\n * @example\n * ```ts\n * import {L} from 'ts-toolbelt'\n *\n * type test0 = L.CompulsoryKeys<[1, 2, 3]> // {0: 1, 1: 2, 2: 3}\n * ```\n */\nexport type CompulsoryKeys =\n OCompulsoryKeys>\n" }, { "path": "sources/List/Concat.ts", "content": "import {List} from './List'\n\n/**\n * Attach `L1` at the end of `L`\n * @param L to concat with\n * @param L1 to be attached\n * @returns [[List]]\n * @example\n * ```ts\n * import {L} from 'ts-toolbelt'\n *\n * type test0 = L.Concat<[1, 2], [3, 4]> // [1, 2, 3, 4]\n * type test1 = L.Concat<[1, 2], [[3], 4]> // [1, 2, [3], 4]\n * type test2 = L.Concat<[1, 2], number[]> // [1, 2, ...number[]]\n * type test3 = L.Concat // [1, 2, 3]\n * ```\n */\nexport type Concat =\n [...L, ...L1]\n" }, { "path": "sources/List/Diff.ts", "content": "import {Diff as ODiff} from '../Object/Diff'\nimport {ListOf} from '../Object/ListOf'\nimport {Match} from '../Any/_Internal'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Get a [[List]] that is the difference between `L` & `L1`\n * (`L`'s differences have priority over `L1`'s if entries overlap)\n * (If `match = 'default'`, no type checks are done)\n * @param L to check differences with\n * @param L1 to check differences against\n * @param match (?=`'default'`) to change precision\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Diff =\n ListOf, ObjectOf, match>>\n" }, { "path": "sources/List/Drop.ts", "content": "import {Tail} from './Tail'\nimport {Cast} from '../Any/Cast'\nimport {IterationOf} from '../Iteration/IterationOf'\nimport {Iteration} from '../Iteration/Iteration'\nimport {Way} from '../Iteration/_Internal'\nimport {List} from './List'\nimport {Pos} from '../Iteration/Pos'\nimport {Prev} from '../Iteration/Prev'\nimport {Prepend} from './Prepend'\nimport {Naked} from './_Internal'\nimport {Extends} from '../Any/Extends'\n\n/**\n * @hidden\n */\ntype DropForth = {\n 0: DropForth, Prev>\n 1: L\n}[Extends<0, Pos>]\n\n/**\n * @hidden\n */\ntype DropBack, LN extends List = []> = {\n 0: DropBack, Prepend]>>\n 1: LN\n}[Extends<-1, Pos>]\n\n/**\n * @hidden\n */\ntype __Drop = {\n '->': DropForth\n '<-': DropBack\n}[way]\n\n/**\n * @hidden\n */\nexport type _Drop =\n __Drop, IterationOf, way> extends infer X\n ? Cast\n : never\n\n/**\n * Remove `N` entries out of `L`\n * @param L to remove from\n * @param N to remove out\n * @param way (?=`'->'`) from front: '->', from end: '<-'\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Drop =\n L extends unknown\n ? N extends unknown\n ? _Drop\n : never\n : never\n" }, { "path": "sources/List/Either.ts", "content": "import {Key} from './_Internal'\nimport {Either as OEither} from '../Object/Either'\nimport {ObjectOf} from './ObjectOf'\nimport {_ListOf} from '../Object/ListOf'\nimport {List} from './List'\nimport {Boolean} from '../Boolean/_Internal'\n\n/**\n * Split `L` into a [[Union]] with `K` keys in such a way that none of\n * the keys are ever present with one another within the different unions.\n * @param L to split\n * @param K to split with\n * @param strict (?=`1`) to force excess property checks https://github.com/microsoft/TypeScript/issues/20863\n * @returns [[List]] [[Union]]\n * @example\n * ```ts\n * ```\n */\nexport type Either =\n OEither, `${K & number}` | K, strict> extends infer OE\n ? OE extends unknown\n ? _ListOf\n : never\n : never\n" }, { "path": "sources/List/Exclude.ts", "content": "import {Match} from '../Any/_Internal'\nimport {ListOf} from '../Object/ListOf'\nimport {Exclude as OExclude} from '../Object/Exclude'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Exclude the entries of `L1` out of `L`\n * (If `match = 'default'`, no type checks are done)\n * @param L to remove from\n * @param L1 to remove out\n * @param match (?=`'default'`) to change precision\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Exclude =\n ListOf, ObjectOf, match>>\n" }, { "path": "sources/List/ExcludeKeys.ts", "content": "import {ExcludeKeys as OExcludeKeys} from '../Object/ExcludeKeys'\nimport {Match} from '../Any/_Internal'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Exclude the keys of `L1` out of the keys of `L`\n * (If `match = 'default'`, no type checks are done)\n * @param L to remove the keys from\n * @param L1 to remove the keys out\n * @param match (?=`'default'`) to change precision\n * @returns [[Key]]\n * @example\n * ```ts\n * ```\n */\nexport type ExcludeKeys =\n OExcludeKeys, ObjectOf, match>\n" }, { "path": "sources/List/Extract.ts", "content": "import {KeySet} from './KeySet'\nimport {Pick} from './Pick'\nimport {List} from './List'\n\n/**\n * Pick a range of entries (portion) from `L`\n * @param L to pick from\n * @param From to start with\n * @param To to end with\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Extract =\n Pick>\n" }, { "path": "sources/List/Filter.ts", "content": "import {Filter as OFilter} from '../Object/Filter'\nimport {ListOf} from '../Object/ListOf'\nimport {Match} from '../Any/_Internal'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Filter out of `L` the entries that match `M`\n * @param L to remove from\n * @param M to select entries\n * @param match (?=`'default'`) to change precision\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Filter =\n ListOf, M, match>>\n" }, { "path": "sources/List/FilterKeys.ts", "content": "import {FilterKeys as OFilterKeys} from '../Object/FilterKeys'\nimport {Match} from '../Any/_Internal'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Filter out the keys of `L` which entries match `M`\n * @param L to remove from\n * @param M to select entries\n * @param match (?=`'default'`) to change precision\n * @returns [[Key]]\n * @example\n * ```ts\n * ```\n */\nexport type FilterKeys =\n OFilterKeys, M, match>\n" }, { "path": "sources/List/Flatten.ts", "content": "import {List} from './List'\nimport {_UnNest} from './UnNest'\nimport {Cast} from '../Any/Cast'\nimport {Equals} from '../Any/Equals'\nimport {Iteration} from '../Iteration/Iteration'\nimport {IterationOf} from '../Iteration/IterationOf'\nimport {Extends} from '../Any/Extends'\nimport {Next} from '../Iteration/Next'\nimport {Or} from '../Boolean/Or'\nimport {Boolean} from '../Boolean/_Internal'\n\n/**\n * @hidden\n */\ntype __Flatten> = {\n 0: __Flatten<_UnNest, L, strict, limit, Next>\n 1: L\n}[Or, Extends>]\n\n/**\n * @hidden\n */\nexport type _Flatten =\n __Flatten> extends infer X\n ? Cast\n : never\n\n/**\n * Remove all dimensions of `L` (10 max)\n * @param L to un-nest\n * @param strict (?=`1`) `0` to not preserve tuples\n * @param limit (?=`string`) to stop un-nesting at\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Flatten =\n L extends unknown\n ? _Flatten\n : never\n" }, { "path": "sources/List/Group.ts", "content": "import {_Drop} from './Drop'\nimport {_Take} from './Take'\nimport {Cast} from '../Any/Cast'\nimport {Append} from './Append'\nimport {List} from './List'\nimport {Extends} from '../Any/Extends'\n\n/**\n * @hidden\n */\ntype __Group = {\n 0: __Group<_Drop, N, Append>>\n 1: LN\n}[Extends>]\n\n/**\n * @hidden\n */\nexport type _Group =\n __Group extends infer X\n ? Cast\n : never\n\n/**\n * Split `L` into sub-[[List]]s every `N`\n * @param L to group\n * @param N to split at\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Group =\n L extends unknown\n ? N extends unknown\n ? _Group\n : never\n : never\n" }, { "path": "sources/List/Has.ts", "content": "import {Match} from '../Any/_Internal'\nimport {Has as OHas} from '../Object/Has'\nimport {Key} from './_Internal'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Check whether `L` has a entry of key `K` that matches `M`\n * @param L to be inspected\n * @param K to choose entry\n * @param M (?=`any`) to check entry type\n * @param match (?=`'default'`) to change precision\n * @returns [[Boolean]]\n * @example\n * ```ts\n * ```\n */\nexport type Has =\n OHas, `${K & number}` | K, M, match>\n" }, { "path": "sources/List/HasPath.ts", "content": "import {HasPath as OHasPath} from '../Object/HasPath'\nimport {Match} from '../Any/_Internal'\nimport {Key} from '../Any/Key'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Check whether `L` has nested entries that match `M`\n * @param L to be inspected\n * @param Path to be followed\n * @param M (?=`any`) to check entry type\n * @param match (?=`'default'`) to change precision\n * @returns [[Boolean]]\n * @example\n * ```ts\n * ```\n */\nexport type HasPath, M extends any = any, match extends Match = 'default'> =\n OHasPath, Path, M, match>\n" }, { "path": "sources/List/Head.ts", "content": "import {Length} from './Length'\nimport {List} from './List'\n\n/**\n * Get the first entry of `L`\n * @param L to extract from\n * @returns [[Any]]\n * @example\n * ```ts\n * ```\n */\nexport type Head =\n Length extends 0\n ? never\n : L[0]\n" }, { "path": "sources/List/Includes.ts", "content": "import {Match} from '../Any/_Internal'\nimport {Includes as OIncludes} from '../Object/Includes'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Check whether `L` has entries that match `M`\n * @param L to be inspected\n * @param M to check entry type\n * @param match (?=`'default'`) to change precision\n * @returns [[Boolean]]\n * @example\n * ```ts\n * ```\n */\nexport type Includes =\n OIncludes, M, match>\n" }, { "path": "sources/List/Intersect.ts", "content": "import {Intersect as OIntersect} from '../Object/Intersect'\nimport {Match} from '../Any/_Internal'\nimport {ListOf} from '../Object/ListOf'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Get the intersecting entries of `L` & `L1`\n * (If `match = 'default'`, no type checks are done)\n * @param L to check similarities with\n * @param L1 to check similarities against\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Intersect =\n ListOf, ObjectOf, match>>\n" }, { "path": "sources/List/IntersectKeys.ts", "content": "import {Match} from '../Any/_Internal'\nimport {IntersectKeys as OIntersectKeys} from '../Object/IntersectKeys'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Get the intersecting entries of `L` & `L1`\n * (If `match = 'default'`, no type checks are done)\n * @param L to check similarities with\n * @param L1 to check similarities against\n * @returns [[Key]]\n * @example\n * ```ts\n * ```\n */\nexport type IntersectKeys =\n OIntersectKeys, L1, match>\n" }, { "path": "sources/List/KeySet.ts", "content": "import {Range} from '../Number/Range'\nimport {UnionOf} from './UnionOf'\n\n/**\n * Create a set of keys\n * @param From to start with\n * @param To to end with\n * @returns [[Key]]\n * @example\n * ```ts\n * ```\n */\nexport type KeySet =\n UnionOf'>>\n" }, { "path": "sources/List/Last.ts", "content": "import {Tail} from './Tail'\nimport {Length} from './Length'\nimport {List} from './List'\n\n/**\n * Get the last entry of `L`\n * @param L to extract from\n * @returns [[Any]]\n * @example\n * ```ts\n * ```\n */\nexport type Last =\n L[Length>]\n" }, { "path": "sources/List/LastKey.ts", "content": "import {Length} from './Length'\nimport {Tail} from './Tail'\nimport {List} from './List'\n\n/**\n * Get the last index of `L`\n * @param L to get from\n * @returns `number`\n * @example\n * ```ts\n * ```\n */\nexport type LastKey =\n Length>\n" }, { "path": "sources/List/Length.ts", "content": "import {List} from './List'\n\n/**\n * Get the length of `L`\n * @param L to get length\n * @returns [[String]] or `number`\n * @example\n * ```ts\n * ```\n */\nexport type Length =\n L['length']\n" }, { "path": "sources/List/List.ts", "content": "/**\n * A [[List]]\n * @param A its type\n * @returns [[List]]\n * @example\n * ```ts\n * type list0 = [1, 2, 3]\n * type list1 = number[]\n * ```\n */\nexport type List = ReadonlyArray\n" }, { "path": "sources/List/Longest.ts", "content": "import {Has} from '../Union/Has'\nimport {List} from './List'\n\n/**\n * Get the longest [[List]] of `L` & `L1`\n * (`L` has priority if both lengths are equal)\n * @param L to compare length\n * @param L1 to compare length\n * @returns `L | L1`\n * @example\n * ```ts\n * ```\n */\nexport type Longest =\n L extends unknown ? L1 extends unknown ?\n {0: L1, 1: L}[Has]\n : never : never\n" }, { "path": "sources/List/Merge.ts", "content": "import {Merge as OMerge} from '../Object/Merge'\nimport {List} from './List'\nimport {Depth} from '../Object/_Internal'\nimport {BuiltIn} from '../Misc/BuiltIn'\nimport {Cast} from '../Any/Cast'\n\n/**\n * Accurately merge the fields of `L` with the ones of `L1`. It is\n * equivalent to the spread operator in JavaScript. [[Union]]s and [[Optional]]\n * fields will be handled gracefully.\n *\n * (โš ๏ธ needs `--strictNullChecks` enabled)\n * @param L to complete\n * @param L1 to copy from\n * @param depth (?=`'flat'`) 'deep' to do it deeply\n * @param ignore (?=`BuiltIn`) types not to merge\n * @param fill (?=`undefined`) types of `O` to be replaced with ones of `O1`\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Merge =\n Cast, List>\n" }, { "path": "sources/List/MergeAll.ts", "content": "import {MergeAll as OMergeAll} from '../Object/MergeAll'\nimport {List} from '../List/List'\nimport {Depth} from '../Object/_Internal'\nimport {BuiltIn} from '../Misc/BuiltIn'\nimport {Cast} from '../Any/Cast'\n\n/**\n * [[Merge]] a list of [[List]]s into `L`. Merges from left to right, first\n * items get completed by the next ones (last-in completes).\n * @param L to start with\n * @param Ls to merge\n * @param depth (?=`'flat'`) 'deep' to do it deeply\n * @param ignore (?=`BuiltIn`) types not to merge\n * @param fill (?=`undefined`) types of `O` to be replaced with ones of `O1`\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type MergeAll, depth extends Depth = 'flat', ignore extends object = BuiltIn, fill extends any = undefined> =\n Cast, List>\n" }, { "path": "sources/List/Modify.ts", "content": "import {Replace} from '../Union/Replace'\nimport {x} from '../Any/x'\nimport {List} from './List'\nimport {Cast} from '../Any/Cast'\nimport {At} from '../Any/At'\n\n/**\n * Modify `L` with `LMod` & the [[x]] placeholder\n * @param L to copy from\n * @param LMod to copy to\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Modify = Cast<{\n [K in keyof LMod]: Replace, undefined>>\n}, List>\n" }, { "path": "sources/List/NonNullable.ts", "content": "import {_Pick} from '../Object/Pick'\nimport {Key} from './_Internal'\nimport {NonNullable as UNonNullable} from '../Union/NonNullable'\nimport {Depth} from '../Object/_Internal'\nimport {BuiltIn} from '../Misc/BuiltIn'\nimport {Cast} from '../Any/Cast'\nimport {List} from './List'\n\n/**\n * @hidden\n */\nexport type NonNullableFlat = {\n [P in keyof O]: P extends K\n ? UNonNullable\n : O[P]\n} & {}\n\n/**\n * @hidden\n */\ntype _NonNullableDeep = {\n [K in keyof O]: O[K] extends BuiltIn\n ? O[K]\n : NonNullableDeep\n}\n\n/**\n * @hidden\n */\nexport type NonNullableDeep =\n _NonNullableDeep>\n\n/**\n * @hidden\n */\nexport type NonNullablePart = {\n 'flat': NonNullableFlat\n 'deep': NonNullableDeep\n}[depth]\n\n/**\n * Make some entries of `L` not nullable (deeply or not)\n * @param L to make non nullable\n * @param K (?=`Key`) to choose fields\n * @param depth (?=`'flat'`) 'deep' to do it deeply\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type NonNullable =\n Cast, List>\n" }, { "path": "sources/List/NonNullableKeys.ts", "content": "import {NonNullableKeys as ONonNullableKeys} from '../Object/NonNullableKeys'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Get the keys of `L` that are non-nullable\n * @param L\n * @returns [[Key]]\n * @example\n * ```ts\n * ```\n */\nexport type NonNullableKeys =\n ONonNullableKeys>\n" }, { "path": "sources/List/Nullable.ts", "content": "import {Key} from './_Internal'\nimport {List} from './List'\nimport {Update} from '../Object/Update'\nimport {x} from '../Any/x'\nimport {Cast} from '../Any/Cast'\n\n/**\n * Make some entries of `L` nullable (deeply or not)\n * @param L to make nullable\n * @param K (?=`Key`) to choose fields\n * @param depth (?=`'flat'`) 'deep' to do it deeply\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Nullable =\n Cast, List>\n" }, { "path": "sources/List/NullableKeys.ts", "content": "import {NullableKeys as ONullableKeys} from '../Object/NullableKeys'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Get the keys of `L` that are nullable\n * @param L\n * @returns [[Key]]\n * @example\n * ```ts\n * ```\n */\nexport type NullableKeys =\n ONullableKeys>\n" }, { "path": "sources/List/ObjectOf.ts", "content": "import {_Omit} from '../Object/Omit'\nimport {_Pick} from '../Object/Pick'\nimport {Length} from './Length'\nimport {List} from './List'\n\n/**\n * Transform a [[List]] into an [[Object]] equivalent\n * @param L to transform\n * @returns [[Object]]\n * @example\n * ```ts\n * ```\n */\nexport type ObjectOf =\n O extends unknown\n ? number extends Length // detect arrays\n ? _Pick // preserves arrays\n : _Omit // transforms tuples\n : never\n" }, { "path": "sources/List/Omit.ts", "content": "import {_Omit as _OOmit} from '../Object/Omit'\nimport {_ListOf} from '../Object/ListOf'\nimport {Key} from './_Internal'\nimport {List} from './List'\nimport {ObjectOf} from './ObjectOf'\n\n/**\n * @hidden\n */\nexport type _Omit =\n _ListOf<_OOmit, `${K & number}` | K>>\n\n/**\n * Remove out of `L` the entries of key `K`\n * @param L to remove from\n * @param K to chose entries\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Omit =\n L extends unknown\n ? _Omit\n : never\n" }, { "path": "sources/List/Optional.ts", "content": "import {Cast} from '../Any/Cast'\nimport {OptionalPart} from '../Object/Optional'\nimport {Depth} from '../Object/_Internal'\nimport {List} from './List'\n\n/**\n * Make `L` optional (deeply or not)\n * @param L to make optional\n * @param depth (?=`'flat'`) 'deep' to do it deeply\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Optional =\n Cast, List>\n" }, { "path": "sources/List/OptionalKeys.ts", "content": "import {OptionalKeys as OOptionalKeys} from '../Object/OptionalKeys'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Get the keys of `L` that are optional\n * @param L\n * @returns [[Key]]\n * @example\n * ```ts\n * ```\n */\nexport type OptionalKeys =\n OOptionalKeys>\n" }, { "path": "sources/List/Overwrite.ts", "content": "import {Overwrite as OOverwrite} from '../Object/Overwrite'\nimport {Cast} from '../Any/Cast'\nimport {List} from './List'\n\n/**\n * Update the entries of `L` with the ones of `L1`\n * @param L to update\n * @param L1 to update with\n * @returns [[Object]]\n * @example\n * ```ts\n * ```\n */\nexport type Overwrite =\n Cast, List>\n" }, { "path": "sources/List/Partial.ts", "content": "import {Partial as OPartial} from '../Object/Partial'\nimport {Depth} from '../Object/_Internal'\nimport {Cast} from '../Any/Cast'\nimport {List} from './List'\n\n/**\n * Make all fields of `O` optional (deeply or not)\n * @param L to make optional\n * @param depth (?=`'flat'`) 'deep' to do it deeply\n * @returns [[List]]\n * @example\n * ```ts\n * import {O} from 'ts-toolbelt'\n *\n * type L = [1, 2, 3, [4, [5]]]\n *\n * type test0 = O.Partial\n * type test1 = O.Partial\n * ```\n */\nexport type Partial =\n Cast, List>\n" }, { "path": "sources/List/Patch.ts", "content": "import {Patch as OPatch} from '../Object/Patch'\nimport {List} from './List'\nimport {Depth} from '../Object/_Internal'\nimport {BuiltIn} from '../Misc/BuiltIn'\nimport {Cast} from '../Any/Cast'\n\n/**\n * Complete the fields of `L` with the ones of `L1`. This is a version of\n * [[Merge]] that does NOT handle optional fields, it only completes fields of `O`\n * with the ones of `O1` if they don't exist.\n *\n * (โš ๏ธ needs `--strictNullChecks` enabled)\n * @param L to complete\n * @param L1 to copy from\n * @param depth (?=`'flat'`) 'deep' to do it deeply\n * @param ignore (?=`BuiltIn`) types not to merge\n * @param fill (?=`never`) types of `O` to be replaced with ones of `O1`\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Patch =\n Cast, List>\n" }, { "path": "sources/List/PatchAll.ts", "content": "import {PatchAll as OPatchAll} from '../Object/PatchAll'\nimport {List} from '../List/List'\nimport {Depth} from '../Object/_Internal'\nimport {BuiltIn} from '../Misc/BuiltIn'\nimport {Cast} from '../Any/Cast'\n\n/**\n * [[Patch]] a list of [[List]]s into `L`. Patches from left to right, first\n * items get completed by the next ones (last-in completes).\n * @param O to start with\n * @param Os to patch\n * @param depth (?=`'flat'`) 'deep' to do it deeply\n * @param ignore (?=`BuiltIn`) types not to merge\n * @param fill (?=`never`) types of `O` to be replaced with ones of `O1`\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type PatchAll, depth extends Depth = 'flat', ignore extends object = BuiltIn, fill extends any = never> =\n Cast, List>\n" }, { "path": "sources/List/Path.ts", "content": "import {Path as OPath} from '../Object/Path'\nimport {Key} from '../Any/Key'\nimport {List} from './List'\n\n/**\n * Get in `L` the type of nested properties\n * @param L to be inspected\n * @param Path to be followed\n * @returns [[Any]]\n * @example\n * ```ts\n * ```\n */\nexport type Path> =\n OPath\n" }, { "path": "sources/List/Paths.ts", "content": "import {Paths as OPaths} from '../Object/Paths'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Get all the possible paths of `L`\n * (โš ๏ธ this won't work with circular-refs)\n * @param L to be inspected\n * @returns [[String]][]\n * @example\n * ```ts\n * ```\n */\nexport type Paths =\n OPaths>\n" }, { "path": "sources/List/Pick.ts", "content": "import {_Pick as _OPick} from '../Object/Pick'\nimport {_ListOf} from '../Object/ListOf'\nimport {Key} from './_Internal'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * @hidden\n */\nexport type _Pick =\n _ListOf<_OPick, `${K & number}` | K>>\n\n/**\n * Extract out of `L` the entries of key `K`\n * @param L to extract from\n * @param K to chose entries\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Pick =\n L extends unknown\n ? _Pick\n : never\n" }, { "path": "sources/List/Pop.ts", "content": "import {_Omit} from './Omit'\nimport {List} from './List'\n\n/**\n * Remove the last element out of `L`\n * @param L to remove from\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Pop =\n L extends (readonly [...infer LBody, any] | readonly [...infer LBody, any?])\n ? LBody\n : L\n" }, { "path": "sources/List/Prepend.ts", "content": "import {List} from './List'\n\n/**\n * Add an element `A` at the beginning of `L`\n * @param L to append to\n * @param A to be added to\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Prepend =\n [A, ...L]\n" }, { "path": "sources/List/Readonly.ts", "content": "import {Depth} from '../Object/_Internal'\nimport {ReadonlyPart} from '../Object/Readonly'\nimport {List} from './List'\nimport {Cast} from '../Any/Cast'\n\n/**\n * Make `L` readonly (deeply or not)\n * @param L to make readonly\n * @param depth (?=`'flat'`) 'deep' to do it deeply\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Readonly =\n Cast, List>\n" }, { "path": "sources/List/ReadonlyKeys.ts", "content": "import {ReadonlyKeys as OReadonlyKeys} from '../Object/ReadonlyKeys'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Get the keys of `L` that are readonly\n * @param L\n * @returns [[Key]]\n * @example\n * ```ts\n * ```\n */\nexport type ReadonlyKeys =\n OReadonlyKeys>\n" }, { "path": "sources/List/Remove.ts", "content": "import {KeySet} from './KeySet'\nimport {Omit} from './Omit'\nimport {List} from './List'\n\n/**\n * Remove out of `L` a range of entries\n * @param L to remove from\n * @param From to start from\n * @param To to end with\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Remove =\n Omit>\n" }, { "path": "sources/List/Repeat.ts", "content": "import {Next} from '../Iteration/Next'\nimport {Prepend} from './Prepend'\nimport {IterationOf} from '../Iteration/IterationOf'\nimport {Iteration} from '../Iteration/Iteration'\nimport {Cast} from '../Any/Cast'\nimport {List} from './List'\nimport {Extends} from '../Any/Extends'\nimport {Pos} from '../Iteration/Pos'\n\n/**\n * @hidden\n */\ntype __Repeat> = {\n 0: __Repeat, Next>\n 1: L\n}[Extends, N>]\n\n/**\n * @hidden\n */\nexport type _Repeat =\n __Repeat extends infer X\n ? Cast\n : never\n\n/**\n * Fill a [[List]] with `N` times `A`\n * @param A to fill with\n * @param N to repeat it\n * @param L (?=`[]`) to be filled\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Repeat =\n N extends unknown\n ? L extends unknown\n ? _Repeat\n : never\n : never\n" }, { "path": "sources/List/Replace.ts", "content": "import {Replace as OReplace} from '../Object/Replace'\nimport {Match} from '../Any/_Internal'\nimport {Cast} from '../Any/Cast'\nimport {List} from './List'\n\n/**\n * Update with `A` the entries of `L` that match `M`\n * @param O to update\n * @param M to select fields\n * @param A to update with\n * @param match (?=`'default'`) to change precision\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Replace =\n Cast, List>\n" }, { "path": "sources/List/Required.ts", "content": "import {Depth} from '../Object/_Internal'\nimport {RequiredPart} from '../Object/Required'\nimport {List} from './List'\nimport {Cast} from '../Any/Cast'\n\n/**\n * Make `L` required (deeply or not)\n * @param L to make required\n * @param depth (?=`'flat'`) 'deep' to do it deeply\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Required =\n Cast, List>\n" }, { "path": "sources/List/RequiredKeys.ts", "content": "import {RequiredKeys as ORequiredKeys} from '../Object/RequiredKeys'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Get the keys of `L` that are readonly\n * @param L\n * @returns [[Key]]\n * @example\n * ```ts\n * ```\n */\nexport type RequiredKeys =\n ORequiredKeys>\n" }, { "path": "sources/List/Reverse.ts", "content": "import {Prepend} from './Prepend'\nimport {Pos} from '../Iteration/Pos'\nimport {Next} from '../Iteration/Next'\nimport {Length} from './Length'\nimport {IterationOf} from '../Iteration/IterationOf'\nimport {Iteration} from '../Iteration/Iteration'\nimport {Cast} from '../Any/Cast'\nimport {List} from './List'\nimport {Naked} from './_Internal'\nimport {Extends} from '../Any/Extends'\n\n/**\n * @hidden\n */\ntype __Reverse> = {\n 0: __Reverse]>, Next>\n 1: LO\n}[Extends, Length>]\n\n/**\n * @hidden\n */\nexport type _Reverse =\n __Reverse, LO> extends infer X\n ? Cast\n : never\n\n/**\n * Turn a [[List]] the other way around\n * @param L to reverse\n * @param LO (?=`[]`) to prepend to\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Reverse =\n L extends unknown\n ? _Reverse\n : never\n" }, { "path": "sources/List/Select.ts", "content": "import {Match} from '../Any/_Internal'\nimport {Select as OSelect} from '../Object/Select'\nimport {ListOf} from '../Object/ListOf'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Extract the entries of `L` that match `M`\n * @param L to extract from\n * @param M to select entries\n * @param match (?=`'default'`) to change precision\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Select =\n ListOf, M, match>>\n" }, { "path": "sources/List/SelectKeys.ts", "content": "import {Match} from '../Any/_Internal'\nimport {SelectKeys as OSelectKeys} from '../Object/SelectKeys'\nimport {ObjectOf} from './ObjectOf'\nimport {List} from './List'\n\n/**\n * Get the keys of `L` which entries match `M`\n * @param L to extract from\n * @param M to select entries\n * @param match (?=`'default'`) to change precision\n * @returns [[Key]]\n * @example\n * ```ts\n * ```\n */\nexport type SelectKeys =\n OSelectKeys, M, match>\n" }, { "path": "sources/List/Shortest.ts", "content": "import {Has} from '../Union/Has'\nimport {List} from './List'\n\n/**\n * Get the shortest [[List]] of `L` & `L1`\n * (`L` has priority if both lengths are equal)\n * @param L to compare length\n * @param L1 to compare length\n * @returns `L | L1`\n * @example\n * ```ts\n * ```\n */\nexport type Shortest =\n L extends unknown ? L1 extends unknown ?\n {0: L1, 1: L}[Has]\n : never : never\n" }, { "path": "sources/List/Tail.ts", "content": "import {List} from './List'\n\n/**\n * Remove the first item out of a [[List]]\n * @param L\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Tail =\n L extends readonly []\n ? L\n : L extends readonly [any?, ...infer LTail]\n ? LTail\n : L\n" }, { "path": "sources/List/Take.ts", "content": "import {IterationOf} from '../Iteration/IterationOf'\nimport {Iteration} from '../Iteration/Iteration'\nimport {Pos} from '../Iteration/Pos'\nimport {Prepend} from './Prepend'\nimport {Way} from '../Iteration/_Internal'\nimport {List} from './List'\nimport {Prev} from '../Iteration/Prev'\nimport {Cast} from '../Any/Cast'\nimport {Tail} from './Tail'\nimport {Extends} from '../Any/Extends'\n\n/**\n * starts in reverse from `N` till `N` = 0\n * @hidden\n */\ntype TakeForth, LN extends List = []> = {\n 0: TakeForth, Prepend]>>\n 1: LN\n}[Extends<-1, Pos>]\n\n/**\n * starts in reverse from the end till `N` = 0\n * @hidden\n */\ntype TakeBack = {\n 0: TakeBack, Prev>\n 1: L\n}[Extends<0, Pos>]\n\n/**\n * @hidden\n */\ntype __Take = {\n '->': TakeForth // Reverse logic to work naturally #`Prepend`\n '<-': TakeBack // Reverse logic to work naturally #`Prepend`\n}[way]\n\n/**\n * @hidden\n */\nexport type _Take =\n __Take, way> extends infer X\n ? Cast\n : never\n\n/**\n * Extract `N` entries out of `L`\n * @param L to extract from\n * @param N to extract out\n * @param way (?=`'->'`) to extract from end\n * @returns [[List]]\n * @example\n * ```ts\n * ```\n */\nexport type Take =\n L extends unknown\n ? N extends unknown\n ? _Take\n : never\n : never\n" }, { "path": "sources/List/UnNest.ts", "content": "import {Concat} from './Concat'\nimport {Append} from './Append'\nimport {Cast} from '../Any/Cast'\nimport {Length} from './Length'\nimport {Iteration} from '../Iteration/Iteration'\nimport {IterationOf} from '../Iteration/IterationOf'\nimport {Next} from '../Iteration/Next'\nimport {Pos} from '../Iteration/Pos'\nimport {List} from './List'\nimport {UnionOf} from './UnionOf'\nimport {Naked} from './_Internal'\nimport {Extends} from '../Any/Extends'\nimport {Boolean} from '../Boolean/_Internal'\nimport {Not} from '../Boolean/Not'\nimport {And} from '../Boolean/And'\n\n/**\n * @hidden\n */\ntype UnNestLoose =\n (UnionOf extends infer UL // make `L` a union\n ? UL extends unknown // for each in union\n ? UL extends List // if its an array\n ? UnionOf