Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.2 KB

README.md

File metadata and controls

36 lines (25 loc) · 1.2 KB

ng_universities

A package to retrieve the list of universities in Nigeria approved by the Nigerian University Commission (NUC)

Build Status

Coverage Status

Getting started.

Install this package from npm by running the command npm install ng_universities

API

var ng_universities = require('ng_universities')

getUniversities(category)

The getUniversities() function takes in a category of the university which can be "public", "private", "federal" or "state" and returns the list of universities. If no parameter is supplied, getUniversities() returns a list of all the universities.

//EXAMPLE
const ng_universities = require('ng_universities');
let federalUniversities = ng_universities.getUniversities("federal")
console.log(`Federal Universities: ${federalUniversities} \n`)

Tests

Run npm test to run tests

Author

George Benjamin

License

MIT