Class RailCompanyDataService

constructor

• new RailCompanyDataService(db): RailCompanyDataService

• Parameters

  • db: Db

  Returns RailCompanyDataService

getRailCompany

• getRailCompany(companyId): Promise<null | RailCompanyEntity>

• Get rail company from database

  Parameters

  • companyId: string

  Returns Promise<null | RailCompanyEntity>

  Promise<RailCompanyEntity | undefined> RailCompany data if fetched successfully, or null if data not found by id

listPaginatedRailCompanies

• listPaginatedRailCompanies(opts): Promise<PaginatedFindResult<RailCompanyEntity>>

• List paginated rail companies

  Parameters

  • opts: ParsedPaginatedListQuery

    paginated list query options

  Returns Promise<PaginatedFindResult<RailCompanyEntity>>

  paginated rail company list query result

normalizeRailCompanyResponse

• normalizeRailCompanyResponse(company): Promise<RailCompany>

• Normalize rail company to response format

  Parameters

  • company: RailCompany

    rail company model

  Returns Promise<RailCompany>

  RailCompanyResponse which aligns with the API docs format to return to frontend

normalizeRailCompanyResponses

• normalizeRailCompanyResponses(companies): Promise<RailCompany[]>

• Normalize list of rail company responses

  Parameters

  • companies: RailCompany[]

    rail company models

  Returns Promise<RailCompany[]>

  RailCompanyResponse which aligns with the API docs format to return to frontend

Static Readonly COLLECTION_RAIL_COMPANIES