pdok API

Everything the package exports, by the path you import it from. Open an export for its signature and options.

@evolve-framework/pdok

PdokAddressLookupModule, PdokAddressSuggestModule, pdokCityLookup and their options

Classes

PdokAddressLookupModuleQuery.addressLookup for Dutch addresses by postal code and house number, from PDOK's free Locatieserver.

import { PdokAddressLookupModule } from "@evolve-framework/pdok";

Extends AbstractModule<unknown>

new PdokAddressLookupModule(options?: PdokAddressLookupOptions)

Option	Type	Description
baseUrl?	string	Defaults to the public Locatieserver v3.1.
timeoutMs?	number	How long a request may take before it counts as unavailable. Defaults to 3 seconds.
fetch?	((url: string | URL | Request, options?: RequestInit | undefined, spanName?: string | undefined) => Promise<Response>)	Defaults to the framework's traced fetch.

PdokAddressSuggestModuleQuery.addressSuggest and addressResolve for type-ahead entry of Dutch addresses, from PDOK's free Locatieserver.

import { PdokAddressSuggestModule } from "@evolve-framework/pdok";

Extends AbstractModule<unknown>

new PdokAddressSuggestModule(options?: PdokAddressLookupOptions)

Option	Type	Description
baseUrl?	string	Defaults to the public Locatieserver v3.1.
timeoutMs?	number	How long a request may take before it counts as unavailable. Defaults to 3 seconds.
fetch?	((url: string | URL | Request, options?: RequestInit | undefined, spanName?: string | undefined) => Promise<Response>)	Defaults to the framework's traced fetch.

Functions

pdokCityLookupThe official city of a Dutch address by postcode and house number, from PDOK's Locatieserver, for an engine to store instead of a differently cased one.

import { pdokCityLookup } from "@evolve-framework/pdok";

function pdokCityLookup(
  options?: PdokAddressLookupOptions,
): CityLookup

Option	Type	Description
baseUrl?	string	Defaults to the public Locatieserver v3.1.
timeoutMs?	number	How long a request may take before it counts as unavailable. Defaults to 3 seconds.
fetch?	((url: string | URL | Request, options?: RequestInit | undefined, spanName?: string | undefined) => Promise<Response>)	Defaults to the framework's traced fetch.

Returns CityLookup

Not listed: 1 options types. They appear as the tables under the constructors and functions they type.