Class VegvesenClient

Client for anonymous public reads from Statens vegvesen's NVDB API Les V4.

Index

Methods

getRoadNetwork getRoadNetworkAll getRoadObject getRoadObjectType getRoadObjectTypes searchRoadObjects searchRoadObjectsAll

Methods

getRoadNetwork

getRoadNetwork(
parameters?: RoadNetworkParameters,
options?: RequestOptions,
): Promise<OpenDataResponse<RoadNetworkResult>>
Reads one page of the public segmented road network.
Parameters
- parameters: RoadNetworkParameters = {}
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<RoadNetworkResult>>
- Defined in src/providers/vegvesen/client.ts:493

getRoadNetworkAll

getRoadNetworkAll(
parameters?: RoadNetworkParameters,
options?: RequestOptions & PaginateOptions,
): AsyncGenerator<RoadNetworkSegment, void, undefined>
Iterates every matching segment of the public road network, following NVDB's continuation marker. Bounded by maxItems and maxPages.
Parameters
- parameters: RoadNetworkParameters = {}
- Optionaloptions: RequestOptions & PaginateOptions
Returns AsyncGenerator<RoadNetworkSegment, void, undefined>
- Defined in src/providers/vegvesen/client.ts:470

getRoadObject

getRoadObject(
    typeId: number,
    objectId: number,
    options?: RequestOptions,
): Promise<OpenDataResponse<RoadObject>>
Gets one current public road object by type ID and object ID.
Parameters
- typeId: number
- objectId: number
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<RoadObject>>
- Defined in src/providers/vegvesen/client.ts:398

getRoadObjectType

getRoadObjectType(
typeId: number,
options?: RequestOptions,
): Promise<OpenDataResponse<RoadObjectType>>
Gets full public metadata for one road-object type.
Parameters
- typeId: number
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<RoadObjectType>>
- Defined in src/providers/vegvesen/client.ts:315

getRoadObjectTypes

getRoadObjectTypes(
options?: RequestOptions,
): Promise<OpenDataResponse<RoadObjectType[]>>
Lists public road-object types from the current NVDB data catalogue.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<RoadObjectType[]>>
- Defined in src/providers/vegvesen/client.ts:289

searchRoadObjects

searchRoadObjects(
parameters: RoadObjectSearchParameters,
options?: RequestOptions,
): Promise<OpenDataResponse<RoadObjectSearchResult>>
Searches public road objects and returns NVDB's opaque continuation marker.
Parameters
- parameters: RoadObjectSearchParameters
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<RoadObjectSearchResult>>
- Defined in src/providers/vegvesen/client.ts:352

searchRoadObjectsAll

searchRoadObjectsAll(
parameters: RoadObjectSearchParameters,
options?: RequestOptions & PaginateOptions,
): AsyncGenerator<RoadObject, void, undefined>
Iterates every matching public road object, following NVDB's continuation marker. Bounded by maxItems and maxPages.
Parameters
- parameters: RoadObjectSearchParameters
- Optionaloptions: RequestOptions & PaginateOptions
Returns AsyncGenerator<RoadObject, void, undefined>
- Defined in src/providers/vegvesen/client.ts:444