national-high-school v1.0.6

NationalHighSchoolData-cn

National high school data of China

Install

$ npm install national-high-school --save

Use

import NationalHighSchoolData from 'national-high-school'

API

• Get all schools

/**
* get all schools
* @return {array} schools - school list
*/
NationalHighSchoolData.schools()

• Get school by school code

/**
* get school by school code
* @param  {string || number} code - school code
* @return {object} school - school instance
*/
NationalHighSchoolData.getByCode(code)

• Get school by area code

/**
* get schools by area code
* @param  {string || number} areaCode - area code
* @return {array} schools - school list
*/
NationalHighSchoolData.getByAreaCode(areaCode)

• Search school by name

/**
* search school by name
* @param  {string} name - school name
* @return {array} schools - school list
*/
NationalHighSchoolData.searchByName(name)