Class TSOpenLDB

Hierarchy

TSOpenLDB

Implements

ITSOpenLDB

Index

Constructors

constructor

Properties

Constructors

constructor

new TSOpenLDB(__namedParameters: { apiKey: string; debugEnabled: boolean }): TSOpenLDB

- Defined in index.ts:99
Parameters
- __namedParameters: { apiKey: string; debugEnabled: boolean }
  - apiKey: string
  - debugEnabled: boolean
Returns TSOpenLDB

Properties

Private _apiKey

_apiKey: string

Private _debugEnabled

_debugEnabled: boolean = false

Methods

Private CallRequiredParams

CallRequiredParams(params: IOperationParams): TStaffOperation

- Defined in index.ts:109
Parameters
- params: IOperationParams
Returns TStaffOperation

Private fetchFromDarwin

fetchFromDarwin(operation: ESOAPStaffAction, xml: string): Promise<IOpenLDBSVWSStationBoard | IOpenLDBSVWSServiceDetails | IDarwinServicesByHeadcodeFnReturn | string>

- Defined in index.ts:329
Parameters
- operation: ESOAPStaffAction
- xml: string
Returns Promise<IOpenLDBSVWSStationBoard | IOpenLDBSVWSServiceDetails | IDarwinServicesByHeadcodeFnReturn | string>

getArrBoardWithDetails

getArrBoardWithDetails(__namedParameters: { _params: _params; numRows: number; time: string; timeOffset: number; timeWindow: number }): Promise<IOpenLDBSVWSStationBoard>

- Defined in index.ts:403
Parameters
- __namedParameters: { _params: _params; numRows: number; time: string; timeOffset: number; timeWindow: number }
  - _params: _params
  - numRows: number
  - time: string
  - timeOffset: number
  - timeWindow: number
Returns Promise<IOpenLDBSVWSStationBoard>

getArrDepBoardWithDetails

getArrDepBoardWithDetails(__namedParameters: { _params: _params; filterType: EFilterType; timeOffset: number; timeWindow: number }): Promise<IOpenLDBSVWSStationBoard>

- Defined in index.ts:416
Parameters
- __namedParameters: { _params: _params; filterType: EFilterType; timeOffset: number; timeWindow: number }
  - _params: _params
  - filterType: EFilterType
  - timeOffset: number
  - timeWindow: number
Returns Promise<IOpenLDBSVWSStationBoard>

getArrivalBoardByCRS

getArrivalBoardByCRS(__namedParameters: { _params: _params; getNonPassengerServices: boolean; numRows: number; services: EServices; time: Date; timeWindow: number }): Promise<IOpenLDBSVWSStationBoard>

- Defined in index.ts:428
Parameters
- __namedParameters: { _params: _params; getNonPassengerServices: boolean; numRows: number; services: EServices; time: Date; timeWindow: number }
  - _params: _params
  - getNonPassengerServices: boolean
  - numRows: number
  - services: EServices
  - time: Date
  - timeWindow: number
Returns Promise<IOpenLDBSVWSStationBoard>

getArrivalBoardByTIPLOC

getArrivalBoardByTIPLOC(__namedParameters: { _params: _params; getNonPassengerServices: boolean; numRows: number; services: EServices; time: Date }): Promise<IOpenLDBSVWSStationBoard>

- Defined in index.ts:440
Parameters
- __namedParameters: { _params: _params; getNonPassengerServices: boolean; numRows: number; services: EServices; time: Date }
  - _params: _params
  - getNonPassengerServices: boolean
  - numRows: number
  - services: EServices
  - time: Date
Returns Promise<IOpenLDBSVWSStationBoard>

getArrivalDepartureBoardByCRS

getArrivalDepartureBoardByCRS(__namedParameters: { _params: _params; getNonPassengerServices: boolean; numRows: number; services: EServices; time: Date }): Promise<IOpenLDBSVWSStationBoard>

- Defined in index.ts:452
Parameters
- __namedParameters: { _params: _params; getNonPassengerServices: boolean; numRows: number; services: EServices; time: Date }
  - _params: _params
  - getNonPassengerServices: boolean
  - numRows: number
  - services: EServices
  - time: Date
Returns Promise<IOpenLDBSVWSStationBoard>

getArrivalDepartureBoardByTIPLOC

getArrivalDepartureBoardByTIPLOC(__namedParameters: { _params: _params; getNonPassengerServices: boolean; numRows: number; services: EServices; time: Date }): Promise<IOpenLDBSVWSStationBoard>

- Defined in index.ts:464
Parameters
- __namedParameters: { _params: _params; getNonPassengerServices: boolean; numRows: number; services: EServices; time: Date }
  - _params: _params
  - getNonPassengerServices: boolean
  - numRows: number
  - services: EServices
  - time: Date
Returns Promise<IOpenLDBSVWSStationBoard>

getDepBoardWithDetails

getDepBoardWithDetails(__namedParameters: { _params: _params; numRows: number; time: string; timeOffset: number; timeWindow: number }): Promise<IOpenLDBSVWSStationBoard>

- Defined in index.ts:476
Parameters
- __namedParameters: { _params: _params; numRows: number; time: string; timeOffset: number; timeWindow: number }
  - _params: _params
  - numRows: number
  - time: string
  - timeOffset: number
  - timeWindow: number
Returns Promise<IOpenLDBSVWSStationBoard>

getDepartureBoardByCRS

getDepartureBoardByCRS(__namedParameters: { _params: _params; filterType: EFilterType; getNonPassengerServices: boolean; numRows: number; services: EServices; time: Date; timeWindow: number }): Promise<IOpenLDBSVWSStationBoard>

- Defined in index.ts:491
Parameters
- __namedParameters: { _params: _params; filterType: EFilterType; getNonPassengerServices: boolean; numRows: number; services: EServices; time: Date; timeWindow: number }
  - _params: _params
  - filterType: EFilterType
  - getNonPassengerServices: boolean
  - numRows: number
  - services: EServices
  - time: Date
  - timeWindow: number
Returns Promise<IOpenLDBSVWSStationBoard>

getDepartureBoardByTIPLOC

getDepartureBoardByTIPLOC(__namedParameters: { _params: _params; filterType: EFilterType; getNonPassengerServices: boolean; numRows: number; services: EServices; time: Date }): Promise<IOpenLDBSVWSStationBoard>

- Defined in index.ts:503
Parameters
- __namedParameters: { _params: _params; filterType: EFilterType; getNonPassengerServices: boolean; numRows: number; services: EServices; time: Date }
  - _params: _params
  - filterType: EFilterType
  - getNonPassengerServices: boolean
  - numRows: number
  - services: EServices
  - time: Date
Returns Promise<IOpenLDBSVWSStationBoard>

getDisruptionList

getDisruptionList(__namedParameters: { _params: _params }): Promise<string>

- Defined in index.ts:515
Parameters
- __namedParameters: { _params: _params }
  - _params: _params
Returns Promise<string>

getFastestDepartures

getFastestDepartures(__namedParameters: { _params: _params; services: EServices; time: Date; timeWindow: number }): Promise<IOpenLDBSVWSStationBoard>

- Defined in index.ts:520
Parameters
- __namedParameters: { _params: _params; services: EServices; time: Date; timeWindow: number }
  - _params: _params
  - services: EServices
  - time: Date
  - timeWindow: number
Returns Promise<IOpenLDBSVWSStationBoard>

getFastestDeparturesWithDetails

getFastestDeparturesWithDetails(__namedParameters: { _params: _params; services: EServices; time: Date; timeWindow: number }): Promise<IOpenLDBSVWSStationBoard>

- Defined in index.ts:532
Parameters
- __namedParameters: { _params: _params; services: EServices; time: Date; timeWindow: number }
  - _params: _params
  - services: EServices
  - time: Date
  - timeWindow: number
Returns Promise<IOpenLDBSVWSStationBoard>

getHistoricDepartureBoard

getHistoricDepartureBoard(__namedParameters: { _params: _params; numRows: number; timeWindow: number }): Promise<IOpenLDBSVWSStationBoard>

- Defined in index.ts:550
Parameters
- __namedParameters: { _params: _params; numRows: number; timeWindow: number }
  - _params: _params
  - numRows: number
  - timeWindow: number
Returns Promise<IOpenLDBSVWSStationBoard>

getHistoricServiceDetails

getHistoricServiceDetails(__namedParameters: { _params: _params }): Promise<IOpenLDBSVWSServiceDetails>

- Defined in index.ts:568
Parameters
- __namedParameters: { _params: _params }
  - _params: _params
Returns Promise<IOpenLDBSVWSServiceDetails>

getHistoricTimeLine

getHistoricTimeLine(__namedParameters: { _params: _params }): Promise<string>

- Defined in index.ts:579
Parameters
- __namedParameters: { _params: _params }
  - _params: _params
Returns Promise<string>

getNextDepartures

getNextDepartures(__namedParameters: { _params: _params; services: EServices; time: Date; timeWindow: number }): Promise<IOpenLDBSVWSStationBoard>

- Defined in index.ts:584
Parameters
- __namedParameters: { _params: _params; services: EServices; time: Date; timeWindow: number }
  - _params: _params
  - services: EServices
  - time: Date
  - timeWindow: number
Returns Promise<IOpenLDBSVWSStationBoard>

getNextDeparturesWithDetails

getNextDeparturesWithDetails(__namedParameters: { _params: _params; services: EServices; time: Date; timeWindow: number }): Promise<IOpenLDBSVWSStationBoard>

- Defined in index.ts:596
Parameters
- __namedParameters: { _params: _params; services: EServices; time: Date; timeWindow: number }
  - _params: _params
  - services: EServices
  - time: Date
  - timeWindow: number
Returns Promise<IOpenLDBSVWSStationBoard>

getServiceDetailsByRid

getServiceDetailsByRid(__namedParameters: { _params: _params }): Promise<IOpenLDBSVWSServiceDetails>

- Defined in index.ts:609
Parameters
- __namedParameters: { _params: _params }
  - _params: _params
Returns Promise<IOpenLDBSVWSServiceDetails>

Private logToConsole

logToConsole(message?: string | object): void

- Defined in index.ts:324
Parameters
- Default value message: string | object = "No message"
Returns void

Private mapParamsToSOAPXml

mapParamsToSOAPXml(operation: EStaffOperation, params: IOperationParams): string

- Defined in index.ts:374
Parameters
- operation: EStaffOperation
- params: IOperationParams
Returns string

queryHistoricServices

queryHistoricServices(__namedParameters: { _params: _params; timeFilter: Date }): Promise<string>

- Defined in index.ts:615
Parameters
- __namedParameters: { _params: _params; timeFilter: Date }
  - _params: _params
  - timeFilter: Date
Returns Promise<string>

queryServices

queryServices(__namedParameters: { _params: _params; sdd: string | Date }): Promise<IDarwinServicesByHeadcodeFnReturn>

- Defined in index.ts:620
Parameters
- __namedParameters: { _params: _params; sdd: string | Date }
  - _params: _params
  - sdd: string | Date
Returns Promise<IDarwinServicesByHeadcodeFnReturn>

Generated using TypeDoc