{"_id":"swot-simple","_rev":"123-43777d9efaad28475bb829456e5f2a02","name":"swot-simple","description":"detect whether an email address is under an edu domain","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"swot-simple","version":"1.0.0","description":"detect whether an email address is under an edu domain","main":"index.js","scripts":{"test":"tape test.js","doc":"dox -r < index.js | doxme"},"keywords":["swot","email","edu"],"author":{"name":"Tom MacWright, Contributors, SWOT originally by Lee Reilly"},"license":"ISC","devDependencies":{"dox":"^0.6.1","doxme":"^1.4.2","progress":"^1.1.8","request":"^2.51.0","tape":"^3.5.0","zipfile":"^0.5.7"},"dependencies":{"tldjs":"^1.5.2"},"repository":{"type":"git","url":"git@github.com:mapbox/swot-simple.git"},"gitHead":"764f63d4f13dfbc7250344ddfa70e7bfcdc9cbb3","bugs":{"url":"https://github.com/mapbox/swot-simple/issues"},"homepage":"https://github.com/mapbox/swot-simple","_id":"swot-simple@1.0.0","_shasum":"e9985f5bb04fe66fc7c6e92d76901ccb021db4c3","_from":".","_npmVersion":"2.3.0","_nodeVersion":"0.10.36","_npmUser":{"name":"tmcw","email":"tom@macwright.org"},"maintainers":[{"name":"tmcw","email":"tom@macwright.org"}],"dist":{"shasum":"e9985f5bb04fe66fc7c6e92d76901ccb021db4c3","tarball":"https://registry.npmjs.org/swot-simple/-/swot-simple-1.0.0.tgz","integrity":"sha512-h5hLC93d2Rp37sLbqQOuXXsqdJQNvLaNwP8hF+0C6NLTcLkwHYKW2FMGYfh9i/jycj0ojsRWF+7pbDeoVJQnQg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA4DEEI1Iwv8VqTSkxT7JpS3Gd5M4z8x/lyuUZBsLXmPAiEAiaK/Ojfutp6XJW7wQjv8w+DL0G5DQcFjILbSQpDkBRs="}]},"deprecated":"This module is now under the @mapbox namespace: install @mapbox/swot-simple instead"}},"readme":"# swot-simple\n\n[![build status](https://secure.travis-ci.org/mapbox/swot-simple.png)](http://travis-ci.org/mapbox/swot-simple)\n\nSimple & fast JavaScript implementation of [Swot](https://github.com/leereilly/swot)\n\n* only depends on tldjs\n* compiles swot data into a single json file, so bootup is fast\n* passes all of Swot's tests.\n* fast\n\n## Install\n\n    npm install swot-simple\n\n## API\n\n### `isAcademic(email)`\n\nCheck an email for whether it is from an educational domain or not.\n\n\n### Parameters\n\n| parameter | type   | description          |\n| --------- | ------ | -------------------- |\n| `email`   | String | a full email address |\n\n\n### Example\n\n```js\nswot.isAcademic('me@gmail.com'); // false\nswot.isAcademic('lee@harvard.edu'); // true\n```\n\n\n### `getInstitutionName(email)`\n\nCheck an email for whether it is from an educational domain or not,\nand if it is a known educational institution, return its name.\n\n\n### Parameters\n\n| parameter | type   | description          |\n| --------- | ------ | -------------------- |\n| `email`   | String | a full email address |\n\n\n### Example\n\n```js\nswot.getInstitutionName('lreilly@cs.strath.ac.uk');\n// \"lreilly@cs.strath.ac.uk\"\n```\n\n## Build Process\n\nswot's main data is transformed by `build.js`. The list of tlds is transformed\nfrom the [Ruby](https://github.com/leereilly/swot/blob/master/lib/swot/academic_tlds.rb) to\n[json](tlds.json) by hand.\n","maintainers":[{"name":"mapbox-admin","email":"accounts@mapbox.com"}],"time":{"modified":"2022-06-27T03:02:42.606Z","created":"2015-01-31T19:36:42.044Z","1.0.0":"2015-01-31T19:36:42.044Z"},"homepage":"https://github.com/mapbox/swot-simple","keywords":["swot","email","edu"],"repository":{"type":"git","url":"git@github.com:mapbox/swot-simple.git"},"author":{"name":"Tom MacWright, Contributors, SWOT originally by Lee Reilly"},"bugs":{"url":"https://github.com/mapbox/swot-simple/issues"},"license":"ISC","readmeFilename":"README.md"}