{"_id":"ts-keycode-enum","_rev":"9-724ed5c8d4ad98ef91e9257ced575441","name":"ts-keycode-enum","description":"A TypeScript enum definition that maps human-friendly key names to JavaScript key codes","dist-tags":{"latest":"1.0.6"},"versions":{"1.0.0":{"name":"ts-keycode-enum","version":"1.0.0","description":"A TypeScript enum definition that maps human-friendly key names to JavaScript key codes","main":"dist/js/Key.enum.js","types":"dist/declarations/Key.enum.d.ts","scripts":{"build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/nfriend/ts-keycode-enum.git"},"keywords":["typescript","javascript","keycodes","key","enum","ts"],"author":{"name":"Nathan Friend","email":"hello@nathanfriend.io","url":"http://nathanfriend.io"},"license":"MIT","bugs":{"url":"https://github.com/nfriend/ts-keycode-enum/issues"},"homepage":"https://github.com/nfriend/ts-keycode-enum#readme","devDependencies":{"typescript":"^2.1.6"},"gitHead":"39e7f597cc5cdbbac0429a1a8645d89eeec4ccfd","_id":"ts-keycode-enum@1.0.0","_shasum":"96dcef86d89cbcaaaaf68f546aa9a21174a776c0","_from":".","_npmVersion":"4.0.5","_nodeVersion":"7.4.0","_npmUser":{"name":"nathanfriend","email":"contact@nathanfriend.com"},"dist":{"shasum":"96dcef86d89cbcaaaaf68f546aa9a21174a776c0","tarball":"https://registry.npmjs.org/ts-keycode-enum/-/ts-keycode-enum-1.0.0.tgz","integrity":"sha512-Zgm4cWgkF58tAcb84srkc/2Awxxsgm0zv+lWDqQM/mBpuobCSqSTvSMFCqy84B8GEtxwbCj/vlJ2mimA3a8+Ng==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHnT2xU2/U1ROOH86LAGVawlPt78RhNsxbldh1nDGipDAiEA/JyUO4j4d4OE99vHqrSmFeJg/TMHqN2cFAbWxSfmSCo="}]},"maintainers":[{"name":"nathanfriend","email":"contact@nathanfriend.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/ts-keycode-enum-1.0.0.tgz_1486754765975_0.9289694686885923"},"directories":{}},"1.0.1":{"name":"ts-keycode-enum","version":"1.0.1","description":"A TypeScript enum definition that maps human-friendly key names to JavaScript key codes","main":"dist/js/Key.enum.js","types":"dist/declarations/Key.enum.d.ts","scripts":{"build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/nfriend/ts-keycode-enum.git"},"keywords":["typescript","javascript","keycodes","key","enum","ts"],"author":{"name":"Nathan Friend","email":"hello@nathanfriend.io","url":"http://nathanfriend.io"},"license":"MIT","bugs":{"url":"https://github.com/nfriend/ts-keycode-enum/issues"},"homepage":"https://github.com/nfriend/ts-keycode-enum#readme","devDependencies":{"typescript":"^2.1.6"},"gitHead":"130ffb1f434ac9424b84fc84fd92a3e0d1e44d99","_id":"ts-keycode-enum@1.0.1","_shasum":"fee0611d8e83150ac7f86d4f48610899229be908","_from":".","_npmVersion":"4.0.5","_nodeVersion":"7.4.0","_npmUser":{"name":"nathanfriend","email":"contact@nathanfriend.com"},"dist":{"shasum":"fee0611d8e83150ac7f86d4f48610899229be908","tarball":"https://registry.npmjs.org/ts-keycode-enum/-/ts-keycode-enum-1.0.1.tgz","integrity":"sha512-tu8oWQQyljcuvZPTLOodbHz4XAzgtZ/+Inuox/3CUr8+7d4ihr6UU/bhFmoSuRM37J5ElLr+eu/A4A0bI9ynHw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEUFKkRO01SWiFqwmcVhXk8BVLLsF267UW8CUWTC+n6KAiEA0ciilMtetlCdN+Y60MLTtAh58AN5SxEaF+Bah0RglB0="}]},"maintainers":[{"name":"nathanfriend","email":"contact@nathanfriend.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/ts-keycode-enum-1.0.1.tgz_1486754994354_0.1801336593925953"},"directories":{}},"1.0.2":{"name":"ts-keycode-enum","version":"1.0.2","description":"A TypeScript enum definition that maps human-friendly key names to JavaScript key codes","main":"dist/js/Key.enum.js","types":"dist/declarations/Key.enum.d.ts","scripts":{"build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/nfriend/ts-keycode-enum.git"},"keywords":["typescript","javascript","keycodes","key","enum","ts"],"author":{"name":"Nathan Friend","email":"hello@nathanfriend.io","url":"http://nathanfriend.io"},"license":"MIT","bugs":{"url":"https://github.com/nfriend/ts-keycode-enum/issues"},"homepage":"https://github.com/nfriend/ts-keycode-enum#readme","devDependencies":{"typescript":"^2.1.6"},"gitHead":"5e6403e099939e9e8db0be812171631271f1c620","_id":"ts-keycode-enum@1.0.2","_shasum":"721078e0a6c77b753e8b60983004df20bca76e52","_from":".","_npmVersion":"4.0.5","_nodeVersion":"7.4.0","_npmUser":{"name":"nathanfriend","email":"contact@nathanfriend.com"},"dist":{"shasum":"721078e0a6c77b753e8b60983004df20bca76e52","tarball":"https://registry.npmjs.org/ts-keycode-enum/-/ts-keycode-enum-1.0.2.tgz","integrity":"sha512-Pb6eslv7tWfforSRQk+UkhZnaIYuGyQkSqinYs2X+G4HzP16DFb5PSwn1KJGwp26Rd2kThlpA1tKk8KnDXsbZA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDHU1od/C8SAqb6RLkuI69zKYR6LgERDmplR/SOt9OjvwIhAItoqLS7dm6QV6vj6X5q53QYJ3dajLHkMW5y78Y26qDR"}]},"maintainers":[{"name":"nathanfriend","email":"contact@nathanfriend.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/ts-keycode-enum-1.0.2.tgz_1487002978009_0.04834310756996274"},"directories":{}},"1.0.3":{"name":"ts-keycode-enum","version":"1.0.3","description":"A TypeScript enum definition that maps human-friendly key names to JavaScript key codes","main":"dist/js/Key.enum.js","types":"dist/declarations/Key.enum.d.ts","scripts":{"build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/nfriend/ts-keycode-enum.git"},"keywords":["typescript","javascript","keycodes","key","enum","ts"],"author":{"name":"Nathan Friend","email":"hello@nathanfriend.io","url":"http://nathanfriend.io"},"license":"MIT","bugs":{"url":"https://github.com/nfriend/ts-keycode-enum/issues"},"homepage":"https://github.com/nfriend/ts-keycode-enum#readme","devDependencies":{"typescript":"^2.1.6"},"gitHead":"8d3f248d10eadede86b1776517fe878ccafb9a74","_id":"ts-keycode-enum@1.0.3","_shasum":"d7b35c35de260e824f0fb8d3ef36d9c7b50a795a","_from":".","_npmVersion":"4.0.5","_nodeVersion":"7.4.0","_npmUser":{"name":"nathanfriend","email":"contact@nathanfriend.com"},"dist":{"shasum":"d7b35c35de260e824f0fb8d3ef36d9c7b50a795a","tarball":"https://registry.npmjs.org/ts-keycode-enum/-/ts-keycode-enum-1.0.3.tgz","integrity":"sha512-1ZU+3WHe2B+p4BmM31hm1X25/oEhvdEcRlevLciqvPG8le/nBTphgwoXMMp6WqtGjbakGifb4E68vxei/QMcvQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEOQtH9aas+9d95gv/KmE4dpkvf9wNDw6N/KVuu9nooNAiEA87PaG/SeY0O/ilJ5Ww3cGUIu6wOKuTJHd8vP1ahSsJs="}]},"maintainers":[{"name":"nathanfriend","email":"contact@nathanfriend.com"}],"_npmOperationalInternal":{"host":"packages-18-east.internal.npmjs.com","tmp":"tmp/ts-keycode-enum-1.0.3.tgz_1490016946351_0.2664369805715978"},"directories":{}},"1.0.4":{"name":"ts-keycode-enum","version":"1.0.4","description":"A TypeScript enum definition that maps human-friendly key names to JavaScript key codes","main":"dist/js/Key.enum.js","types":"dist/declarations/Key.enum.d.ts","scripts":{"build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/nfriend/ts-keycode-enum.git"},"keywords":["typescript","javascript","keycodes","key","enum","ts"],"author":{"name":"Nathan Friend","email":"hello@nathanfriend.io","url":"http://nathanfriend.io"},"license":"MIT","bugs":{"url":"https://github.com/nfriend/ts-keycode-enum/issues"},"homepage":"https://github.com/nfriend/ts-keycode-enum#readme","devDependencies":{"typescript":"^2.2.1"},"gitHead":"17e1aaa4af11298d7fc46f08a0dd5a9ed6a9174e","_id":"ts-keycode-enum@1.0.4","_shasum":"b7e35bf73d669b561333d5de9a51861e4803ad3e","_from":".","_npmVersion":"3.10.9","_nodeVersion":"6.9.2","_npmUser":{"name":"nathanfriend","email":"contact@nathanfriend.com"},"dist":{"shasum":"b7e35bf73d669b561333d5de9a51861e4803ad3e","tarball":"https://registry.npmjs.org/ts-keycode-enum/-/ts-keycode-enum-1.0.4.tgz","integrity":"sha512-3AqZpBd92IwJGqjkWfv3KGcu3zoJV3v9bULe3IGtGj6pmBYQhRy1fvn01mtEHtD0GNGMx3gUV4kdbaGduYHvbA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCQ7DrUdmt+uyMj+mCapztW774JnIR+uZIZgFRVbR7bfgIhAKXfrVigxUJYsdFBA9S5aWnRQdbAYXTkPR/oYLZKCZn0"}]},"maintainers":[{"name":"nathanfriend","email":"contact@nathanfriend.com"}],"_npmOperationalInternal":{"host":"packages-18-east.internal.npmjs.com","tmp":"tmp/ts-keycode-enum-1.0.4.tgz_1490034779172_0.8223931326065212"},"directories":{}},"1.0.5":{"name":"ts-keycode-enum","version":"1.0.5","description":"A TypeScript enum definition that maps human-friendly key names to JavaScript key codes","main":"dist/js/Key.enum.js","types":"dist/declarations/Key.enum.d.ts","scripts":{"build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/nfriend/ts-keycode-enum.git"},"keywords":["typescript","javascript","keycodes","key","enum","ts"],"author":{"name":"Nathan Friend","email":"hello@nathanfriend.io","url":"http://nathanfriend.io"},"license":"MIT","bugs":{"url":"https://github.com/nfriend/ts-keycode-enum/issues"},"homepage":"https://github.com/nfriend/ts-keycode-enum#readme","devDependencies":{"typescript":"^2.2.1"},"gitHead":"5fd5d7fb08a7c66c93d1422e0c3d832b053ea69b","_id":"ts-keycode-enum@1.0.5","_npmVersion":"5.5.1","_nodeVersion":"8.9.1","_npmUser":{"name":"nathanfriend","email":"contact@nathanfriend.com"},"dist":{"integrity":"sha512-monHcADVfQKmD6/tAgcePuA0hUklNzbb2/m3DYG5+sJ00BryP9Q6zbTjqI3SjKsBhaDpe3QGu+eOU4mVhAaO2g==","shasum":"7d2db9725d6b4e1b2ce895f425335ffa00230db4","tarball":"https://registry.npmjs.org/ts-keycode-enum/-/ts-keycode-enum-1.0.5.tgz","fileCount":8,"unpackedSize":34148,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbITYrCRA9TVsSAnZWagAAvooP/3veVren+gVwjasr11bU\nJm5PAEPQuVFqSoav8YxwP2ETfsQwKUREwK9Co2m34afHvZRU0WbAhKtjLi6S\nEuTJ748IhIvaxZuBtQcv+fYZZznI6qp603nKbH7tsHP91o2Poc4v67AYNX+n\nCtTKJKC/JMIEgYXEo8kQn42cLsM7HHohXp1xhLz4FJ8uCtetTnoefbofMEpx\n02HOBsvbSHj/Dxg5zuuH/Xq/I5BFv9Vxpnz4gFeEP59YDm6Zf6YzCfPry+vE\nAK88Lq0XTBDcnKy4wqNIOqCXzzeN3TXljIyGIceHTgjaYuoKISqoZJhJKiya\nFDxidUkhrs5e4DzJeQOk+LFg1Lvcfeg6sSzae3Z3JY04L2mRteu+clq8Pqw3\nDDjZUTvgUTMbjX79C634mjYeaop3WdeXQ2ATQmllMgX7V3olv1fjzuvRNaM9\nk/7yiiQK7Jqt6ulYYs4jeVGGlU1JXckAgsaK6eC64nUzYta8NbTzKUf9ZI/X\n65IdjUIncDgJOhHSVAUJnIxay742X0YEZSF2GMAlhWahAxaj3eLgjZHNV2S9\nff1fTT80TQF0SC+RZlWO+Yr+Dn+S0G4tCK/t+A2MDwh4VKu8JN3QuLXLkNjW\napZmxyVYUJacdnnnYMpcpVzL+eion2dX7eM/NIvFokXM4QeyYITtqB8PJUOr\nxNMM\r\n=1Cip\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA1d85DSkpjqclReurvOi6YCzn6ottqAdgOZEYZcx+miAiEA//jgsSq/PUAMyMAp+NARHntHIkhH6i5x1a5+GjFGPeE="}]},"maintainers":[{"name":"nathanfriend","email":"contact@nathanfriend.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ts-keycode-enum_1.0.5_1528903211121_0.9376234495542264"},"_hasShrinkwrap":false},"1.0.6":{"name":"ts-keycode-enum","version":"1.0.6","description":"A TypeScript enum definition that maps human-friendly key names to JavaScript key codes","main":"dist/js/Key.enum.js","files":["dist/"],"types":"dist/declarations/Key.enum.d.ts","scripts":{"build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/nfriend/ts-keycode-enum.git"},"keywords":["typescript","javascript","keycodes","key","enum","ts"],"author":{"name":"Nathan Friend","email":"hello@nathanfriend.io","url":"http://nathanfriend.io"},"license":"MIT","bugs":{"url":"https://github.com/nfriend/ts-keycode-enum/issues"},"homepage":"https://github.com/nfriend/ts-keycode-enum#readme","devDependencies":{"typescript":"^2.9.2"},"gitHead":"b1a10e58ac76894a9e133dea3e21ebb000f1749e","_id":"ts-keycode-enum@1.0.6","_npmVersion":"5.5.1","_nodeVersion":"8.9.1","_npmUser":{"name":"nathanfriend","email":"contact@nathanfriend.com"},"dist":{"integrity":"sha512-DF8+Cf/FJJnPRxwz8agCoDelQXKZWQOS/gnnwx01nZ106tPJdB3BgJ9QTtLwXgR82D8O+nTjuZzWgf0Rg4vuRA==","shasum":"aeefd1c2fc7b0557f86a0e696e300905bbb4c1c1","tarball":"https://registry.npmjs.org/ts-keycode-enum/-/ts-keycode-enum-1.0.6.tgz","fileCount":5,"unpackedSize":10835,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbJ55YCRA9TVsSAnZWagAAa0YP/1TS2d96pi7dQ94a0B7o\nEKvrgdq+3A6KhVtf/dr2aFKq4S4rTB7qq/lQufUBVromdByONNirW6/I8ixn\n7Kn2CW6qR0qIwlGJbZD4OU9BdfgUBlz2hJnUe8G6oqKO8JaqX8vo/7ikZOC8\nYxTQ1SpUD9EuvHtMB83gSCbEMdjt7FxBWQZwZ6jdmgVS2pVtoogrmhijJ3sS\nI8hwSFihg4t5Hdq2rGSpdNmqqEXVCdgxJWNsql+1c0XxZZsY36H6Ln6KQFwu\n35gw55OYeWgEtLRXH4PWWqu4O8uAy9VnynHcYb6erOQAnjnqkny/X7a4iN50\n0v8sPbTbIiXxWbDqcWSH5GBKoSk1NJIx5TMThoOWrvHXOrnJ4srB30FX0FSp\nQzjknRzu8QTZbBlMCcD+lJ2ZCSCvOIri3uAPok+mbONH3dlTG+K1lfQLBOgx\nsWDVVftikKxjXsgxbG6Y++smQEYiR8oDjwXQNh8J2tvpCR629YbU9NDUjUQf\nSrBRnTytJrEXf/+sd1xFaJNykhjqenNgnsgaIo+ANEkDM4Dm13YwacQxpLgZ\nHkeAsQbH9NUled0QRgKzUYe/gdLsWs0JmdBLta6npYdhGpNQODU5krk1oEqh\neNYKzlg3XEs4ifIOLyKMyzH2fPYvBt4Q4su9ZkiDNALp6o774FayBOEVu2jB\nXfqv\r\n=LTDB\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCj2+SBjkcKTYMJBx7kCZ8FjB9XsE2uMkT/N+MoUHBliwIgFEaTnGSqLmz3C8aqvzfHHgKzYeeDTaGtn1Qi32pUVFw="}]},"maintainers":[{"name":"nathanfriend","email":"contact@nathanfriend.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ts-keycode-enum_1.0.6_1529323095822_0.6573319719303261"},"_hasShrinkwrap":false}},"readme":"# ts-keycode-enum\r\nA TypeScript enum definition that maps human-friendly key names to JavaScript key codes\r\n\r\n<img align=\"right\" src=\"https://raw.githubusercontent.com/nfriend/ts-keycode-enum/master/logo.jpg\" />\r\n\r\n## Important note\r\n\r\n[`event.which`](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/which) and [`event.keyCode`](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode) have been deprecated.  It is recommended to instead use [`event.key`](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) in combination with this very similar module: [ts-key-enum](https://github.com/nfriend/ts-key-enum).\r\n\r\n## Install\r\n\r\n```bash\r\nnpm install ts-keycode-enum --save\r\n```\r\n\r\n## Purpose\r\n\r\nTired of referencing JavaScript keycodes by number?\r\n\r\n```JavaScript\r\nonKeyPress = (ev) => {\r\n\r\n    // gross\r\n    if (ev.which === 13) {\r\n        ...\r\n    }\r\n}\r\n```\r\n\r\nMe too.  With this module, you can do this instead (in a TypeScript file):\r\n\r\n```JavaScript\r\nonKeyPress = (ev) => {\r\n\r\n    // much better\r\n    if (ev.which === Key.Enter) {\r\n        ...\r\n    }\r\n}\r\n```\r\n\r\n## Usage\r\n\r\nTo use this module, import the `Key` enum at the top of your TypeScript file using the enum:\r\n\r\n```JavaScript\r\nimport { Key } from 'ts-keycode-enum';\r\n```\r\n\r\nYou can now use a readable enum value in place of any raw keycodes throughout the file:\r\n\r\n```JavaScript\r\nif (ev.which === Key.Escape) { ... }\r\n```\r\n\r\nSee [Key.enum.ts](./Key.enum.ts) for a complete list of available keys.\r\n\r\nIn addition, to aid with readability, a number of enum values have aliases.  For example:\r\n\r\n```JavaScript\r\n// this  true - these values are equal\r\nKey.One === Key.ExclamationMark\r\n```\r\n\r\nUse whichever value makes more sense for readability.\r\n\r\n## Building\r\n\r\nTo build this module yourself, first install its dependencies using\r\n\r\n```bash\r\nnpm install\r\n```\r\n\r\nThen, run the build using\r\n\r\n```bash\r\nnpm run build\r\n```\r\n\r\nBuild output is placed in the `dist` directory.\r\n\r\n## Contributions\r\n\r\nThis module only contains some of the most commonly-used key codes.  If it's missing keycodes that you need, feel free to request the codes via an issue or a pull request.\r\n\r\n## License\r\n\r\nMIT","maintainers":[{"name":"nathanfriend","email":"contact@nathanfriend.com"}],"time":{"modified":"2022-06-27T22:10:22.408Z","created":"2017-02-10T19:26:07.878Z","1.0.0":"2017-02-10T19:26:07.878Z","1.0.1":"2017-02-10T19:29:56.495Z","1.0.2":"2017-02-13T16:23:00.042Z","1.0.3":"2017-03-20T13:35:46.915Z","1.0.4":"2017-03-20T18:32:59.786Z","1.0.5":"2018-06-13T15:20:11.190Z","1.0.6":"2018-06-18T11:58:15.914Z"},"homepage":"https://github.com/nfriend/ts-keycode-enum#readme","keywords":["typescript","javascript","keycodes","key","enum","ts"],"repository":{"type":"git","url":"git+https://github.com/nfriend/ts-keycode-enum.git"},"author":{"name":"Nathan Friend","email":"hello@nathanfriend.io","url":"http://nathanfriend.io"},"bugs":{"url":"https://github.com/nfriend/ts-keycode-enum/issues"},"license":"MIT","readmeFilename":"README.md"}