swot-node
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.348 • Public • Published

    Swot 🍎

    Node.js CI Package Quality Dependencies Downloads Last commit

    If you have a product or service and offer academic discounts, there's a good chance there's some manual component to the approval process. Perhaps .edu email addresses are automatically approved because, for the most part at least, they're associated with American post-secondary educational institutions. Perhaps .ac.uk email addresses are automatically approved because they're guaranteed to belong to British universities and colleges. Unfortunately, not every country has an education-specific TLD (Top Level Domain) and plenty of schools use .com or .net.

    Swot is a community-driven or crowdsourced library for verifying that domain names and email addresses are tied to a legitimate university of college - more specifically, an academic institution providing higher education in tertiary, quaternary or any other kind of post-secondary education in any country in the world.

    If you would like to add your school/educational institution, please create a pull request in this repository. Jetbrains/swot does not provide source code to this library, but is included as the dataset as it contains thousands of schools and the team at Jetbrains is verifying and adding many schools every day. A new version of swot-node with an updated dataset is automatically published to NPM every 24 hours.

    Installation

    Add swot-node like other NPM packages, simply run:

    yarn add swot-node

    or

    npm install swot-node

    Usage

    Verify Email Addresses

    const swot = require("swot-node")
    
    await swot.isAcademic('lreilly@stanford.edu')           // true
    await swot.isAcademic('lreilly@strath.ac.uk')           // true
    await swot.isAcademic('lreilly@soft-eng.strath.ac.uk')  // true
    await swot.isAcademic('pedro@ugr.es')                   // true
    await swot.isAcademic('lee@uottawa.ca')                 // true
    await swot.isAcademic('lee@leerilly.net')               // false

    Verify Domain Names

    const swot = require("swot-node")
    
    await swot.isAcademic('harvard.edu')              // true
    await swot.isAcademic('www.harvard.edu')          // true
    await swot.isAcademic('http://www.harvard.edu')   // true
    await swot.isAcademic('http://www.github.com')    // false
    await swot.isAcademic('http://www.rangers.co.uk') // false

    Get all the different names of a school

    const swot = require("swot-node")
    
    await swot.getSchoolNames('www.bbs1-gifhorn.de')
    // => [ "BBS1 Gifhorn", "Berufsbildene Schule 1 Gifhorn" ]
    
    await swot.getSchoolNames('stanford.edu')
    // => [ "Stanford University" ]

    Find School Name

    const swot = require("swot-node")
    
    await swot.getSchoolName('lreilly@cs.strath.ac.uk')
    // => "University of Strathclyde"
    
    await swot.getSchoolName('http://www.stanford.edu')
    // => "Stanford University"
    
    await swot.getSchoolName('https://www.github.com')
    // => false
    
    await swot.getSchoolName('QaPk59GZ9Zv8.edu')
    // => true

    License

    Apache 2.0

    Copyright (c) 2021 Marvin Schopf

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    See Also

    • swot - original ruby version of swot
    • gman - like swot, but for government emails
    • swotphp - PHP port of Swot
    • swot-clj - Clojure port of Swot
    • swot - Go port of Swot

    Install

    npm i swot-node

    Homepage

    swot.js.org/

    DownloadsWeekly Downloads

    366

    Version

    2.0.348

    License

    Apache-2.0

    Unpacked Size

    762 kB

    Total Files

    18590

    Last publish

    Collaborators

    • marvman