{"_id":"jsdoc-plugin-intersection","_rev":"5-05c033ceca43b5c4a1819f1629aeb7b4","name":"jsdoc-plugin-intersection","dist-tags":{"latest":"1.0.4"},"versions":{"1.0.0":{"name":"jsdoc-plugin-intersection","version":"1.0.0","description":"Converts TypeScript-like intersection types to JSDoc compatible union types, that is, from & -> |","author":{"name":"Christopher Eaton","email":"chriseaton@live.com"},"license":"UNLICENSED","homepage":"https://github.com/chriseaton/jsdoc-plugin-intersection#readme","main":"plugin.js","repository":{"type":"git","url":"git+https://github.com/chriseaton/jsdoc-plugin-intersection.git"},"keywords":["jsdoc","plugin","typescript","intersection","union"],"bugs":{"url":"https://github.com/chriseaton/jsdoc-plugin-intersection/issues"},"devDependencies":{"eslint":"^4.19.1"},"gitHead":"f38e52183e58817c89cda88ec66c754f2caf8f58","_id":"jsdoc-plugin-intersection@1.0.0","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-OKFHcnTzfw5t7Sy3z4j/IgYBLDbsIGvEpoIq4xK6lxv32UmAYyv07a/a6H7M4wpzSKR0ip5u866Wgi5iNchnCQ==","shasum":"89c2463a78546e47c1d8589718560120047bf0d4","tarball":"https://registry.npmjs.org/jsdoc-plugin-intersection/-/jsdoc-plugin-intersection-1.0.0.tgz","fileCount":5,"unpackedSize":5629,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdf0n8CRA9TVsSAnZWagAA+cUP/R7q+F1t+QPMy1Ys5Xmx\nLxOlkjvjXXwJRpK4FW/HJEEAZuQMvmXNqGuGVbNwLourTTrVjGoQs0HQlFWi\nSgCtPKv0J4bhAwjlEq94jHZryR6/1eL7yNAXHKjrOdSilOKtllpKlwmk198g\nvxtfqA1aYZVncpsFCm2OxMkzG7i4cCvSfCcID2wV73vsC1tFbUdzNQCeNbfO\n1I3EsWMYGGm55wq/w/gqwNdCmaJL1YUnzX44a1atSszfvzPE0kI0GEYYaRYo\nfFN9OiE2Oe/WCE+bn1aAI6lMReBE9nwRosbUzNuQ7ZzIjMw9r70uc/1Rq3UO\nKnB2u8QYyMJOACwOFdi9cOwuYuyYeT/N2FyyuaCmpdxTRs0hIVdZqhu+lPbo\nQgM2dA5+alF/1m4+GTjUT2MaMklhDfRvI+B20asoJq3K8xkvOWtMc0NEdkQy\nUmMntfYWsYpgx5VdRYllFE4RruFtBX9Tr1T9WqSfDXMsVXnBVo/cqZhytHua\nWPOQwQm5LJTyrRkXNI2QeC3taYlfkr0+y/BtFeSINkak9yTKgpFU5uisDUu1\nr4wQYAOg4gwEvMNkY9c74YRmFB//Okmc2T7awiG2bMeafkVjiv7nmRaZ9bCj\nQf+yjITn2GJAtReR7JQABhra143y8aTwX0TgC0G8a9CpFkSLcG3IXogIo5GO\nq7WM\r\n=xsAW\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFOXIR4Fib0XKiXUXItbfz5z7FTi9FPBDxuJH0gctqKEAiA8t1tZef+KmXY+2bkx7zWP/oHnvuNHU9P8YIHvqMBNlA=="}]},"maintainers":[{"name":"chriseaton","email":"chriseaton@live.com"}],"_npmUser":{"name":"chriseaton","email":"chriseaton@live.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/jsdoc-plugin-intersection_1.0.0_1568623100217_0.5172546867516037"},"_hasShrinkwrap":false},"1.0.1":{"name":"jsdoc-plugin-intersection","version":"1.0.1","description":"Converts TypeScript-like intersection types to JSDoc compatible union types, that is, from & -> |","author":{"name":"Christopher Eaton","email":"chriseaton@live.com"},"license":"UNLICENSED","homepage":"https://github.com/chriseaton/jsdoc-plugin-intersection#readme","main":"plugin.js","repository":{"type":"git","url":"git+https://github.com/chriseaton/jsdoc-plugin-intersection.git"},"keywords":["jsdoc","plugin","typescript","intersection","union"],"bugs":{"url":"https://github.com/chriseaton/jsdoc-plugin-intersection/issues"},"devDependencies":{"eslint":"^4.19.1"},"gitHead":"f42794e66b48c89f6947b23ce4d248020b84f336","_id":"jsdoc-plugin-intersection@1.0.1","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-5Vz6DqFE/+YPwDjV6xpHWEehH5K0bpgyLLNJto2oBP2yftORFc/GbfaoIKJo0hf3EVZ5bgvQBnRhG1PGigyIsw==","shasum":"506b6762eeb4358e2bb851f6a9048bc41f13031f","tarball":"https://registry.npmjs.org/jsdoc-plugin-intersection/-/jsdoc-plugin-intersection-1.0.1.tgz","fileCount":5,"unpackedSize":6144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdf02VCRA9TVsSAnZWagAAA10P/Rj5RftADtRtIyTFRyZx\nFO0oii24CwWgUcZwzmSWXvBx2SbLcTPhp3ESj1fy8E2AoO2MEd1GGxOWmqjK\n41XV3AS6pfjHMmWaaawHgppszb0CaIIj4y7Isj8/MyprKgZV2RgYs3kLJjFW\nntUmsAKmpM5CX/NR2aw4mxyck87xfSyCcMVWtvOwg3tTTH/Iy+SkLV5yeDE4\nuAkNN9zW6ODWwTI4pZrzN8WYWUe+25SHNLmA5F8nqYZSmwLWr0RtTAHo5qAz\nQtd5FqhZo54/oBmVRHVeP3w2Xag4Ajh755T67zMY/iNa96Qk+SOt39Sq+z4x\nGRfnaVh3f2pKoruKI0qVSfpi+E3hp7Jy4/8pWDGhjlLNTuozArbIo+QxyUt5\no+RHeObQM3txCUt7QAx3H/XilQHca74wTAXkwf8Eea40RcJQafuga9w/Y0YI\nl9WFUWzr/zeM37BnUIV0Xw8KxxmZoegdUsmjd8/RoQLb13EzCHNZwG6cOyXW\n9jnsbi4J6WFTcFlqoks9sKT6zS+e54hj4XG/cs7IrK+7uqHnzgd/Skvu02C6\nd+/bPD2Hj9yfGxKb6Ckr/CuyWcHq3ig9sCxsiZXIZzO0m6w3/BJulgyEND4t\n53cjdic9JJV93k9Rl0SFgJBsmEfeP7T/57mtp2v1zKEbYegICmlb5BjP9Vln\npsV6\r\n=TKQp\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDVOJhjPKtYqkvLwZhs3uL+dPQw9v2GVKPkhc44j8d2WAIgG4oVpEqj4alFC5IgvckLGXAlueOiFK5r6kE+6XXJzMo="}]},"maintainers":[{"name":"chriseaton","email":"chriseaton@live.com"}],"_npmUser":{"name":"chriseaton","email":"chriseaton@live.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/jsdoc-plugin-intersection_1.0.1_1568624020895_0.5202293539937151"},"_hasShrinkwrap":false},"1.0.2":{"name":"jsdoc-plugin-intersection","version":"1.0.2","description":"Converts TypeScript-like intersection types to JSDoc compatible union types, that is, from & -> |","author":{"name":"Christopher Eaton","email":"chriseaton@live.com"},"license":"UNLICENSED","homepage":"https://github.com/chriseaton/jsdoc-plugin-intersection#readme","main":"plugin.js","repository":{"type":"git","url":"git+https://github.com/chriseaton/jsdoc-plugin-intersection.git"},"keywords":["jsdoc","plugin","typescript","intersection","union"],"bugs":{"url":"https://github.com/chriseaton/jsdoc-plugin-intersection/issues"},"devDependencies":{"eslint":"^4.19.1"},"gitHead":"70e23e1b0410c203e581b7e5eec44c13c7103c4a","_id":"jsdoc-plugin-intersection@1.0.2","_nodeVersion":"10.16.3","_npmVersion":"6.9.0","dist":{"integrity":"sha512-lqCE44zM2wPv6PjAgzPM/dlrPFUiCVE5DrvntHVvHw5MFObkV+oDYwmO/3TXX7YsD+IdOPbsR4fIx/i+LETgNw==","shasum":"6fb8c1217bdbf1e15cc8d3f874b641fec7b79619","tarball":"https://registry.npmjs.org/jsdoc-plugin-intersection/-/jsdoc-plugin-intersection-1.0.2.tgz","fileCount":5,"unpackedSize":6165,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdhG9NCRA9TVsSAnZWagAAyBwQAIWY7tOgbcDfiSlC4n9P\n63nMy6DCxmNTXe8WIu8Ih3WMLS7Y6LNik+2HQ5ot92cGcOVEOuPh0VILniES\n8AWNg/Vl5SjroH0TvlZC/uRIgvR26qHZTCB15h8go9HCQZbuQfIgUrgNFxGI\nSuzaOe1p2DtDMl3HCArYjEg2xJbM8wSDs3ms+rRDWMoLP0I3SHZQ786wDUYF\nOwetkB0HCYE8T3JRWhPLLyQyAsFOvsU4YAlaqA13JwVwVw1kQIInVL0SbZhe\ngkUSmn2FsgKR9+o21UNsrJj2LboEhn42zeiikllh/h38VcBX180TpsV3YhwL\nfsWaJ9RFSBJGzGMNbK2I3pJK3azw7wy50Ww8os8tTxMxLb7LyZvxr29sQcDV\nxGOrvtFmeDtdKApVOpUYbPaJuFsHEQrNDjO4Uu5x4B5EW1Rel/vuGBvOs1St\ndW/FdYSS2TxFYM2Vy2qZtcCJ9hWo74OVTCubYpANTsybaGP2iNY85AApw322\n5R3bHNwigMo78+ZNx0XrkXLYmV/iwXDm6uBrFlQui5jlDez7HQV9j43O3Uyz\nGthSLh9zcr2nO3Fc3qiK1A6KYuHW9BAnHYY9xa2u9SZf5Q9c3a4PD9p+IIkd\na8ziaKaYEtdXcU2HdHcd9uyresVCAyTzQ/5tyzU+O52hm5yDLBqdVmQQgQda\nENuD\r\n=Ec6o\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDYqL5WKOjSIB/NRmnJmpqvhvlBk+9dSUUUloOROo8cjQIhAK2Jp1+2Ux4wlR9kl3IAumIb5XBIVJB0R/PMUWMsr5JJ"}]},"maintainers":[{"name":"chriseaton","email":"chriseaton@live.com"}],"_npmUser":{"name":"chriseaton","email":"chriseaton@live.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/jsdoc-plugin-intersection_1.0.2_1568960333302_0.20349541832815476"},"_hasShrinkwrap":false},"1.0.3":{"name":"jsdoc-plugin-intersection","version":"1.0.3","description":"Converts TypeScript-like intersection types to JSDoc compatible union types, that is, from & -> |","author":{"name":"Christopher Eaton","email":"chriseaton@live.com"},"license":"UNLICENSED","homepage":"https://github.com/chriseaton/jsdoc-plugin-intersection#readme","main":"plugin.js","repository":{"type":"git","url":"git+https://github.com/chriseaton/jsdoc-plugin-intersection.git"},"keywords":["jsdoc","plugin","typescript","intersection","union"],"bugs":{"url":"https://github.com/chriseaton/jsdoc-plugin-intersection/issues"},"devDependencies":{"eslint":"^4.19.1"},"gitHead":"4a87b0dc235f9c04135e2f0ebd1341341969d76e","_id":"jsdoc-plugin-intersection@1.0.3","_nodeVersion":"12.13.1","_npmVersion":"6.13.7","dist":{"integrity":"sha512-CEAR8SM+zIuk0Sd0VEFddkbJ1+fUU/zsCyPBMIrNrnv0S/LhPrMFPluEj0r1W01CfhMKbBUl66jTdeJpWMZ07A==","shasum":"b215e500e0a2548987447a4030461d442c6809cb","tarball":"https://registry.npmjs.org/jsdoc-plugin-intersection/-/jsdoc-plugin-intersection-1.0.3.tgz","fileCount":5,"unpackedSize":6281,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeohQxCRA9TVsSAnZWagAAaEQP/j3y3EKsFJB6eguUiU0c\nECWQDDOMtzyeEeZHCv6l3Wkz8Bi8xiw8dqow8eq7585AIOtYlpAN4EqQiolG\noQQY/XQubz8qQuSV/7vGmFuaF4+JLT+zG8rZO/bTwhiINjzIsolG1qzYTs2k\nLb77Pkl4PGslfpd4cJ9bj6NpkHqKvMqg27LpBjhw0U/sVJDc/tJKrO1MkLW6\nAJPaD8JdfU1F6xJtMk7T0q0y1cCdn6FhENGI5YfDHMX0Ee7A64Fl14njnybg\ndcyV6BTFrHPRfqPPyo+IDXHC9YVtvT6/A99dLtptAM+ckZ7K7QLRPSCCKFzv\nxFAF7Q3cJmAVIKI5mXmp11gWKDjyqRAaIkoK8NwHj+5PzT6a74jBPsyvzoE2\nI5J+YD4UQgjNl6gkLa9Y9rAxoQ7dk4xCZYRpxo0D3Nc2AUH0zjKfSYqUVRBp\nBYflVSn1EvWSaiN0DNuDj5XCRA0GMGVrKtQptNQt1k6P8GXtRDgaFDkHU6ue\nXwWhPSgme+G2S9O5KqSfu8lumcNFO0nBLhneQwXVYkGaaBA9eaaOuEcgamb6\nZ/Mx3Duiqbzt8Z/huH2UHc9OkX9hcA+3kPEQie+YA0eYsJcmCdWGT+5xThef\nt4ElN9vXURFb5X4QzMAEXFBEZEpoGHJGzOkNaxgpAddt3UfbCZpwLU3QfmQB\nksEq\r\n=T3aZ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCSnmF1EwQtBCZ7hGX0UFNdqzCETA3C5QqJG5Q+N+3NEwIhAIpX5LXey2pNVScT/bJ+fLddoi53KhppoYnv7AU8+D0Y"}]},"maintainers":[{"name":"chriseaton","email":"chriseaton@live.com"}],"_npmUser":{"name":"chriseaton","email":"chriseaton@live.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/jsdoc-plugin-intersection_1.0.3_1587680304917_0.5848449243926734"},"_hasShrinkwrap":false},"1.0.4":{"name":"jsdoc-plugin-intersection","version":"1.0.4","description":"Converts TypeScript-like intersection types to JSDoc compatible union types, that is, from & -> |","author":{"name":"Christopher Eaton","email":"chriseaton@live.com"},"license":"UNLICENSED","homepage":"https://github.com/chriseaton/jsdoc-plugin-intersection#readme","main":"plugin.js","repository":{"type":"git","url":"git+https://github.com/chriseaton/jsdoc-plugin-intersection.git"},"keywords":["jsdoc","plugin","typescript","intersection","union"],"bugs":{"url":"https://github.com/chriseaton/jsdoc-plugin-intersection/issues"},"devDependencies":{"eslint":"^7.12.1"},"gitHead":"8b55f933b5ed4d4bbb681f0b146a3fb3565afcc5","_id":"jsdoc-plugin-intersection@1.0.4","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-5OGv+aWpp0pYRMnhaUeqijesIi/xD2z8IIwIlK+JsQ0sXzMjiWT2YgNSvxcd476pRdh70Xmby/l7GD3NkWcKcQ==","shasum":"32ffe7f74df30ed1e86272c272856e0fd9aa9451","tarball":"https://registry.npmjs.org/jsdoc-plugin-intersection/-/jsdoc-plugin-intersection-1.0.4.tgz","fileCount":5,"unpackedSize":6421,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfmRfTCRA9TVsSAnZWagAAxTgQAKFwCex3JeRlOoIF41po\n4trUZUPJsHnkddjymHpZmhJ3uhg/Wz3w94tK7sKTENGOgBhGm30yher4VTrW\nMmyCXuJ4ATfFOyvejMV+rs1hMpPruos/quE+E1OLD2TGRLEz9b7iNhs7eRZQ\nxDSo6qKqZFXArgfDitDK5EdPXK8U0M7ZproX1wcG+ZzuMgOSdESWwcZek7zh\nn+ojRt+Of5XT+YQWNeaiGKGaiIYNMFR34hPNao4z70+pwJuVa+BLld9xU+r8\nA/b9/omE/thfWsO+5PrmTq75mLotCISWw6JreTf3Y4kJszB+qi33+kdHS8fz\n04n69VU06STDdfbqZ8bs+khLICT4BxvXJFzQFsZ3YYXxKhjCIx4T4n/0oyMN\nNHyrl1SjZMMwVTExVdlWlP+KnQWggruNOb71NsPaIwLleph+CWfKyqvI3hMP\n+6czsZ26MbjlHy5rHvaug/MziNrebH2vqKcK+sH9C0uYeKEypeSfDpQN7Dp3\n5FNZrUgmutKbqw/9fC7IOL/Db4FA8UpadzNyM7SMoCw/iGGBwWhVavJYtB0k\nX2q/oWRGobcxKvdIJZVzvHVwDqHJm4w9hgZTRu9SnxGerdnr7ToJPHfC97Hy\nVT81bwpUZjWlRVF/LmNG55/dIYy0aKDzVfa7hOHgVp1LlXPgeCif8OrIWf9y\nj8TH\r\n=2MT+\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAHtDzeXjdWtsCYmBjwjRd/BgyEcB8typnkSf99oQbaiAiEA7RQ4pLVXXikb16g2vTT08UofLzX4WMS6Z2g8QrB/aeQ="}]},"maintainers":[{"name":"chriseaton","email":"chriseaton@live.com"}],"_npmUser":{"name":"chriseaton","email":"chriseaton@live.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/jsdoc-plugin-intersection_1.0.4_1603868626622_0.46691576450146033"},"_hasShrinkwrap":false}},"time":{"created":"2019-09-16T08:38:20.217Z","1.0.0":"2019-09-16T08:38:20.344Z","modified":"2022-05-06T20:30:08.065Z","1.0.1":"2019-09-16T08:53:41.080Z","1.0.2":"2019-09-20T06:18:53.450Z","1.0.3":"2020-04-23T22:18:25.034Z","1.0.4":"2020-10-28T07:03:46.785Z"},"maintainers":[{"name":"chriseaton","email":"chriseaton@live.com"}],"description":"Converts TypeScript-like intersection types to JSDoc compatible union types, that is, from & -> |","homepage":"https://github.com/chriseaton/jsdoc-plugin-intersection#readme","keywords":["jsdoc","plugin","typescript","intersection","union"],"repository":{"type":"git","url":"git+https://github.com/chriseaton/jsdoc-plugin-intersection.git"},"author":{"name":"Christopher Eaton","email":"chriseaton@live.com"},"bugs":{"url":"https://github.com/chriseaton/jsdoc-plugin-intersection/issues"},"license":"UNLICENSED","readme":"[![NPM](https://nodei.co/npm/jsdoc-plugin-intersection.png)](https://npmjs.org/package/jsdoc-plugin-intersection)\n\n# JSDoc Intersection Plugin\nConverts TypeScript intersection types (joined with an \"&\") to a jsDoc type union \"|\" allowing the file to be \nprocessed downstream. This allows you to use the amperstand \"&\" in your code.\n\nSpecifically, this creates a compatibility between Visual Studio Code's TypeScript documentation and JSDoc, as\nVisual Studio Code's parser uses amperstands for type unions, and JSDoc uses pipes.\n\n## Solving the Problem\nUsing JSDoc in Visual Studio code with their TypeScript-oriented intersection:\n```js\n/**\n * This is my favorite function!\n * @param {SomeClass & {abc: 123}}\n */\n```\nResults in...\n\n> ERROR: Unable to parse a tag's type expression for source file ...: Invalid type expression \"SomeClass & {abc: 123}\": Expected \"|\" but \"&\" found.\n\nUh oh! JSDoc doesn't like this. It's a TypeScript thing and [won't be supported](https://github.com/jsdoc/jsdoc/issues/1285).   \n\n## Resolution\nThankfully, this JSDoc plugin solves the problem by converting your intersecting types to compatible JSDoc union types.\nThere's no need to hack your code together with strange `@typedef`s.\n\n### Just Install\n```sh\nyarn add jsdoc-plugin-intersection --dev\n```\n*or*\n```sh\nnpm install jsdoc-plugin-intersection --save-dev\n```\n\nUpdate your JSDoc configuration, and include the plugin:\n```json\n...\n    \"plugins\": [\n        \"jsdoc-plugin-intersection\"\n    ],\n...\n```\n\nThat's all! ","readmeFilename":"README.md"}