Table of Contents

Installation

via npm

npm i @dinush/[email protected]

Usage

JavaScript (CommonJS)

// Import everything from the package
const { getUniversities, getFaculties, getDegrees } = require("@dinush/srilankan-universities-faculties-degrees");

// Get all universities
const allUniversities = getUniversities();
// ["University of Colombo", "University of Peradeniya", ...]

// Get faculties of a selected university
const colomboFaculties = getFaculties("University of Colombo");
// ["Faculty of Arts", "Faculty of Education", "Faculty of Law", ...]

// Get degrees of a selected faculty at a university
const lawDegrees = getDegrees("University of Colombo", "Faculty of Law");
// ["Bachelor of Laws"]

// Access legacy data structure
const { universities_data } = require("@dinush/srilankan-universities-faculties-degrees");
const rawData = universities_data["University of Colombo"]["Faculty of Law"];
// ["Bachelor of Laws"]

TypeScript / ES Modules

// Import the modern API
import {
  getAllUniversities,
  getFacultiesByUniversity,
  getDegreesByFaculty,
  getUniversity,
  getFaculty,
  validateUniversity,
  validateFaculty,
  University,
  Faculty,
  Degree
} from "@dinush/srilankan-universities-faculties-degrees";

// Get all universities with detailed data
const universities: University[] = getAllUniversities();
/*
[
  { id: "university-of-colombo", name: "University of Colombo", code: "UOC" },
  { id: "university-of-peradeniya", name: "University of Peradeniya", code: "UOP" },
  ...
]
*/

// Get specific university by name or ID (case-insensitive)
const colombo: University | undefined = getUniversity("University of Colombo");
const colomboById: University | undefined = getUniversity("university-of-colombo");

// Validate university existence
const isValid: boolean = validateUniversity("University of Colombo"); // true

// Get faculties of a university with detailed data
const faculties: Faculty[] = getFacultiesByUniversity("University of Colombo");
/*
[
  { id: "faculty-of-law-colombo", universityId: "university-of-colombo", name: "Faculty of Law" },
  { id: "faculty-of-science-colombo", universityId: "university-of-colombo", name: "Faculty of Science" },
  ...
]
*/

// Get specific faculty
const lawFaculty: Faculty | undefined = getFaculty("University of Colombo", "Faculty of Law");

// Validate faculty in university
const facultyExists: boolean = validateFaculty("University of Colombo", "Faculty of Law"); // true

// Get degrees offered by a faculty
const degrees: Degree[] = getDegreesByFaculty("University of Colombo", "Faculty of Law");
/*
[
  {
    id: "bachelor-of-laws-colombo",
    universityId: "university-of-colombo",
    facultyId: "faculty-of-law-colombo",
    name: "Bachelor of Laws"
  }
]
*/

// Get all data
const allUniversities: University[] = getAllUniversities();
const allFaculties: Faculty[] = getAllFaculties();
const allDegrees: Degree[] = getAllDegrees();

Individual Module Imports (TypeScript / ES Modules)

// Import only the universities module
import { getAllUniversities, getUniversity, validateUniversity } from "@dinush/srilankan-universities-faculties-degrees/universities";

// Import only the faculties module
import { getAllFaculties, getFacultiesByUniversity, getFaculty, validateFaculty } from "@dinush/srilankan-universities-faculties-degrees/faculties";

// Import only the degrees module
import { getAllDegrees, getDegreesByFaculty } from "@dinush/srilankan-universities-faculties-degrees/degrees";

// Import legacy compatibility
import { getUniversities, getFaculties, getDegrees } from "@dinush/srilankan-universities-faculties-degrees/compatibility";

API Reference

Modern API (New in v2.0)

Universities

• getAllUniversities(): Returns all universities with detailed data
• getUniversity(nameOrId): Returns a specific university by name or ID (case-insensitive)
• validateUniversity(nameOrId): Validates if a university exists

Faculties

• getAllFaculties(): Returns all faculties with detailed data
• getFacultiesByUniversity(universityNameOrId): Returns faculties for a specific university
• getFaculty(universityNameOrId, facultyNameOrId): Returns a specific faculty
• validateFaculty(universityNameOrId, facultyNameOrId): Validates if a faculty exists in a university

Degrees

• getAllDegrees(): Returns all degree programs with detailed data
• getDegreesByFaculty(universityNameOrId, facultyNameOrId): Returns degrees offered by a specific faculty

Legacy API (v1.x Compatibility)

These functions are maintained for backward compatibility:

• getUniversities(): Returns array of university names
• getFaculties(university): Returns array of faculty names
• getDegrees(university, faculty): Returns array of degree names
• universities_data: Legacy data structure for direct access

Framework Examples

• NodeJS Example
• ReactJS Example
• NextJS Example
• NestJS Example
• Other Examples

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

Author