Class OpenPLZ_Localities

An OpenPLZ-Request specialized into searching for localities.

Config Parameter:

1st: The optional country to retrieve the data of (if not provided either the country specified in the CodBi's Configuration OpenPLZ_Country will be used or, if not specified, "de").
2nd: The POSIX RegEx for the locality's name.
3rd: The POSIX RegEx for the locality's postal code.
4th: An Optional number of pages to load.

Remarks

Initial Author: Callari, Salvatore (Callari@WaXCode.net) Maintainer: Callari, Salvatore (Callari@WaXCode.net)

Hierarchy (View Summary)

OpenPLZ
- OpenPLZ_Localities

Index

Constructors

Methods

Constructors

constructor

new OpenPLZ_Localities(): OpenPLZ_Localities
Returns OpenPLZ_Localities
Inherited from OpenPLZ.constructor

Methods

`Static`retrieve

retrieve(params: unknown[]): unknown
Retrieves the localities found according to the provided params.
Parameters
- params: unknown[]
  The parameters for that Element-Placeholder (provided by CodBi).
Returns unknown
Overrides OpenPLZ.retrieve
- Defined in packages/form/src/js/EPs/openplz.localities.ts:33