{"_id":"@mapbox/swot-simple","_rev":"270-4f7b85ab1078a2ffc50cbbab1fadda9a","name":"@mapbox/swot-simple","description":"detect whether an email address is under an edu domain","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@mapbox/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","build":"browserify -s swot index.js | uglifyjs -c -m > swot-simple.js","doc":"dox -r < index.js | doxme"},"keywords":["swot","email","edu"],"author":{"name":"Tom MacWright, Contributors, SWOT originally by Lee Reilly"},"license":"ISC","devDependencies":{"browserify":"^9.0.3","dox":"^0.6.1","doxme":"^1.4.2","progress":"^1.1.8","tape":"^3.5.0"},"dependencies":{"glob":"^5.0.3","tldjs":"^1.5.2","uglify-js":"^2.4.16"},"repository":{"type":"git","url":"git+ssh://git@github.com/mapbox/swot-simple.git"},"gitHead":"37dcb82bb1f5dcf29a3d552438b9d5032f83ee81","bugs":{"url":"https://github.com/mapbox/swot-simple/issues"},"homepage":"https://github.com/mapbox/swot-simple#readme","_id":"@mapbox/swot-simple@1.0.0","_shasum":"ceaa7825dba692187b0a5f464efe063b429e062b","_from":".","_npmVersion":"3.10.10","_nodeVersion":"7.2.1","_npmUser":{"name":"mapbox-admin","email":"accounts@mapbox.com"},"dist":{"shasum":"ceaa7825dba692187b0a5f464efe063b429e062b","tarball":"https://registry.npmjs.org/@mapbox/swot-simple/-/swot-simple-1.0.0.tgz","integrity":"sha512-FZc82Q1JVN/5yCPOeItmkre5ZjgcoIIqeGnrRGuZOFeiOjGgG+FmKeWftwUdlH6RNzYWmyh7Qv6YEjlH+XuYkw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCd2/EADQKMHMKKQPxYwogs3bc2I5ylm4c+eOPltdhWEgIgeoWZZw2NMKxAQiFMx0bs5osLre0iuLphMEHkg8jKAds="}]},"maintainers":[{"name":"mapbox-admin","email":"accounts@mapbox.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/swot-simple-1.0.0.tgz_1482369722723_0.8727557666134089"},"directories":{}}},"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### `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**Returns** `boolean`, whether the email is educational\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// \"University of Strathclyde\"\n```\n\n\n**Returns** `boolean,String`, false, if the email is not educational. otherwise, a string describing the domain.\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":[{"email":"yannick.meeus+npm+production+ci@mapbox.com","name":"mbx-npm-ci-production"},{"email":"yannick.meeus+npm+staging+ci@mapbox.com","name":"mbx-npm-ci-staging"},{"email":"yannick.meeus+npm+prod+advanced+actions@mapbox.com","name":"mbx-npm-advanced-actions-production"},{"email":"yannick.meeus+npm+staging+advanced+actions@mapbox.com","name":"mbx-npm-advanced-actions-staging"},{"email":"yannick.meeus+npm+prod+09@mapbox.com","name":"mbx-npm-09-production"},{"email":"yannick.meeus+npm+prod+08@mapbox.com","name":"mbx-npm-08-production"},{"email":"yannick.meeus+npm+prod+07@mapbox.com","name":"mbx-npm-07-production"},{"email":"yannick.meeus+npm+prod+06@mapbox.com","name":"mbx-npm-06-production"},{"email":"yannick.meeus+npm+prod+05@mapbox.com","name":"mbx-npm-05-production"},{"email":"yannick.meeus+npm+prod+04@mapbox.com","name":"mbx-npm-04-production"},{"email":"yannick.meeus+npm+prod+03@mapbox.com","name":"mbx-npm-03-production"},{"email":"yannick.meeus+npm+prod+02@mapbox.com","name":"mbx-npm-02-production"},{"email":"yannick.meeus+npm+prod+01@mapbox.com","name":"mbx-npm-01-production"},{"email":"yannick.meeus@mapbox.com","name":"mbx-npm-02-staging"},{"email":"accounts+npmjs-01@mapbox.com","name":"mapbox-npm-01"},{"email":"accounts+npmjs-02@mapbox.com","name":"mapbox-npm-02"},{"email":"accounts+npmjs-07@mapbox.com","name":"mapbox-npm-07"},{"email":"accounts+npmjs-03@mapbox.com","name":"mapbox-npm-03"},{"email":"accounts+npmjs-04@mapbox.com","name":"mapbox-npm-04"},{"email":"accounts+npmjs-09@mapbox.com","name":"mapbox-npm-09"},{"email":"accounts+npmjs-05@mapbox.com","name":"mapbox-npm-05"},{"email":"accounts+npmjs-06@mapbox.com","name":"mapbox-npm-06"},{"email":"accounts+npmjs-08@mapbox.com","name":"mapbox-npm-08"},{"email":"accounts+npmjs-advanced-actions@mapbox.com","name":"mapbox-npm-advanced-actions"},{"email":"accounts+npmjs-npm-ci@mapbox.com","name":"mapbox-npm-ci"},{"email":"accounts+npmjs@mapbox.com","name":"mapbox-npm"},{"email":"accounts@mapbox.com","name":"mapbox-admin"},{"email":"accounts+npm-mapbox-machine-user@mapbox.com","name":"mapbox-machine-user"}],"time":{"modified":"2023-01-12T12:36:31.558Z","created":"2016-12-22T01:22:05.081Z","1.0.0":"2016-12-22T01:22:05.081Z"},"homepage":"https://github.com/mapbox/swot-simple#readme","keywords":["swot","email","edu"],"repository":{"type":"git","url":"git+ssh://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"}