tfk-schools-info

Get information regarding our schools

Usage no npm install needed!

<script type="module">
  import tfkSchoolsInfo from 'https://cdn.skypack.dev/tfk-schools-info';
</script>

README

Build Status Coverage Status js-standard-style

tfk-schools-info

Information regarding our schools

Installation

$ npm i tfk-schools-info

Usage

Call the module with no options to list all schools.

Use an options object to specify your search.

Possible keys:

  • organizationNumber
  • name
  • fullName
  • shortName
  • officialName
  • accessGroup
  • phoneNumber
  • mail

const getSchools = require('tfk-schools-info')
const options = {
  shortName: 'skivs'
}

console.log(getSchools()) //=> All schools

console.log(getSchools(options)) //=> Schools with shortName SKIVS

Basic groups

To list all basic groups from a school

const { getGroups } = require('tfk-schools-info')

console.log(getGroups('SKIVS'))

To list all groups for all schools

const { getGroups } = require('tfk-schools-info')

console.log(getGroups())

License

MIT