Class Stop<SI, RI>

Description

A Stop, i.e. a specific point that is connected to routes and other stops by foot transfers

Type Parameters

SI extends Id
RI extends Id

Implements

IStop<SI, RI>

Index

Constructors

Properties

_transfers connectedRoutes id

Methods

Constructors

constructor

new Stop<SI extends Id, RI extends Id>(
    id: SI,
    connectedRoutes: readonly RI[],
    transfers: FootPath<SI>[],
): Stop<SI, RI>
Transfers are sorted (mutated) by length
Type Parameters
- SI extends Id
- RI extends Id
Parameters
- id: SI
- connectedRoutes: readonly RI[]
- transfers: FootPath<SI>[]
Returns Stop<SI, RI>
- Defined in src/structures/base.ts:58

Properties

`Protected` `Readonly`_transfers

_transfers: ArrayRead<FootPath<SI>>

`Readonly`connectedRoutes

connectedRoutes: readonly RI[]

`Readonly`id

id: SI

Methods

transfers

transfers(maxLength?: number): Generator<FootPath<SI>, void, unknown>
Parameters
- maxLength: number = Infinity
Returns Generator<FootPath<SI>, void, unknown>
Implementation of IStop.transfers
- Defined in src/structures/base.ts:66