fukuoka-city-community-space-finder0.1.0 • Public • Published
Fukuoka City Community Space Finder
Find Community Spaces in Fukuoka City and check reservation status of them. If you want to try it as a stand-alone command, see Running as a stand-alone command section.
$ npm install fukuoka-city-community-space-finder
This library provides four methods;
status. The former three methods are for finding community spaces.
Fukuoka City is separated into several area.
area returns such area names.
Each area has some buildings, such community centre, sports centre, etc.
building returns those buildings in a given area.
var finder = ;// Find areas.finder;// -> [ '中央区', '博多区', '東区', '西区', '南区', '城南区', '早良区' ]// Find buildings in an area.finder;// -> [ '舞鶴公園', '平和中央公園', '中央体育館', '市民会館',// '福岡市文学館（赤煉瓦文化館）', '健康づくりサポートセンター',// 'ＮＰＯボランティア交流センター', '中央市民センター' ]// Find institutions in a building (space).finder;// -> [ '野球場', 'テニスコート１', '球技場' ]
The last method
status checks reservation status of an institution in a week,
which means checking the institution is already occupied, available, or
in maintenance, etc.
var finder = ;finderstatus"中央区" "舞鶴公園" "野球場" 2016 4 25;
The output of
status method is an object and the result of the above sample
is as follows.
However, there is another type of results for complex institutions. For example, if you ask as
var finder = ;finderstatus"中央区" "舞鶴公園" "テニスコート１" 2016 4 25;
you will receive the following result.
Returns a list of areas in Fukuoka city.
A Promise object which returns a list of areas in Fukuoka city.
Returns a list of buildings in a given area.
- area: name of the area.
A Promise object which returns a list of buildings in the area.
Returns a list of institutions in a given area and building.
- area: name of the area.
- building: name of the building.
A Promise object which returns a list of institutions.
status(area, building, institution, year, month, day)
Search reservation statuses of a given institution in a given date.
- area: area name obtained by area method.
- building: building name obtained by building method.
- institution: institution name obtained by institution method.
- year: Year.
- month: Month.
- day: Day.
A Promise object hich returns the result via then method.
Sometimes some error happens, in most of cases it is because of internet speed or server's traffic. At first, you should try again.
Running as a stand-alone command
This module provides
csf command for stand-alone running.
To install the command globally, run
$ npm install -g fukuoka-city-community-space-finder
now you can use
Usage: csf <command> [options] Commands: area List up areas. building List up buildings in an area. institution List up institutions in a building state Search reservation status. Options: --help Show help [boolean]
Each command is related to same name function.
Show the list of areas.
csf area Options: --help Show help [boolean]
Show a list of buildings in an area.
csf building Options: --help Show help [boolean] --area Name of area.
Show a list of institutions in a building.
csf institution Options: --help Show help [boolean] --area Name of area. [required] --building Name of building. [required]
Search reservation status.
csf state Options: --help Show help [boolean] --area Name of area. [required] --building Name of building. [required] --institution Name of institution. [required] --year Year. [default: today] --month Month. [default: today] --day Day. [default: today]
This software is released under the MIT License, see LICENSE.
This project is partly supported by BigData & OpenData Initiative in Kyushu.