vertis-metro

Module that provides API and some UI-components for working with metro

Usage no npm install needed!

<script type="module">
  import vertisMetro from 'https://cdn.skypack.dev/vertis-metro';
</script>

README

Вертикальное метро

Компонент, предоставляющий API для данных о метро всех городов КУБР. Реализован в виде модуля node.js

TODO

  • актуализировать описание
  • перевести оставшиеся города, см. _need-processed директорию
  • дописать тесты на структуру svg-карт
  • jscs, jshint => eslint
  • storybook

API

hasMetro(cityId)

Params

  • cityId Number - Идентификатор города

Returns: Boolean - Флаг наличия в городе метро

getStationById(stationId)

Params

  • stationId Number - Идентификатор станции

Returns: ?Station - Информация о станции

getLineById(lineId)

Params

  • lineId String - Идентификатор линии метро

Returns: ?Line - Информация о линии

getLinesIdsByCityId(cityId)

Params

  • cityId Number - Идентификатор города

Returns: String[] - Список идентификаторов линий

getStationsIdsByLineId(lineId)

Params

  • lineId String - Идентификатор линии метро

Returns: Number[] - Идентификаторы всех станций на этой ветке

getStationsIdsByCityId(cityId)

Params

  • cityId Number - Идентификатор города

Returns: Number[] - Идентификаторы станций метро в этом городе

hasRingLine(cityId)

Params

  • cityId Number - Идентификатор города

Returns: Boolean - Флаг наличия в городе кольцевой линии метрополитена