tfk-schools-info

Information regarding our schools

Installation

``bash
$ 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

`JavasScript

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

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

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

$3

To list all basic groups from a school

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

console.log(getGroups('SKIVS'))
`
To list all groups for all schools

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

console.log(getGroups())
``

License

MIT