Class NinaClient

constructor

• new NinaClient(options?: EngineOptions): NinaClient

  Parameters

  • options: EngineOptions = {}

  Returns NinaClient

Readonlyarchive

Readonlyreference

Readonlywarnings

dashboard

• dashboard(ars: string): Promise<DashboardEntry[]>

  Warnings affecting a district, keyed by its district-level Amtlicher Regionalschlüssel; [] when there are none. A 2xx body that is not an array of objects (null, {}, an error object) rejects with NinaParseError, never as an empty list (a false all-clear). The key is the district-level ARS: 12 digits, the last seven 0. Any other shape (an 8-digit AGS, a municipality-level ARS, a lost leading zero) and a state-level key (digits 3-5 000, other than Hamburg's and Berlin's, which the API would answer with [], a false all-clear) are rejected with a NinaValidationError (whose message is arsProblem's) before any request. A well-formed key NINA knows no district for (a Regierungsbezirk key such as 051000000000, an unassigned number) gets HTTP 404, which rejects as a NinaApiError (status 404) whose detail says no such district key "<ars>".

  Parameters

  • ars: string

  Returns Promise<DashboardEntry[]>

mapData

• mapData(
      source: "mowas" | "katwarn" | "biwapp" | "dwd" | "lhp" | "police",
  ): Promise<MapWarning[]>

  Current warnings from one source, e.g. mapData("dwd"); [] when there are none. A 2xx body that is not an array of objects (null, {}, an error object) rejects with NinaParseError, never as an empty list. A value outside NinaSourceValues (possible from plain JavaScript or a cast) is rejected with a NinaValidationError before any request (see sourceProblem).

  Parameters

  • source: "mowas" | "katwarn" | "biwapp" | "dwd" | "lhp" | "police"

  Returns Promise<MapWarning[]>