Class ProximityService

Service for proximity search operations using Cercalia API.

Remarks

Finds points of interest near a given coordinate. Supports filtering by POI categories and can include routing information to each result.

Hierarchy (View Summary)

CercaliaClient
- ProximityService

Index

Constructors

Properties

Methods

findNearest findNearestByCategory findNearestWithRouting request

Constructors

constructor

new ProximityService(config: CercaliaConfig): ProximityService
Creates a new ProximityService instance.
Parameters
- config: CercaliaConfig
  The Cercalia API configuration.
Returns ProximityService
Overrides CercaliaClient.constructor
- Defined in services/proximity.service.ts:26

Properties

`Protected`config

config: CercaliaConfig

Configuration for the Cercalia API connection.

Methods

findNearest

findNearest(options: ProximityOptions): Promise<ProximityResult>
Finds the nearest POIs to a center coordinate.
Parameters
- options: ProximityOptions
  Search options including center, categories, and limits.
Returns Promise<ProximityResult>
Promise resolving to proximity search results.
Example
```
const service = new ProximityService(config);
const results = await service.findNearest({
  center: { lat: 41.3851, lng: 2.1734 },
  categories: ['C001'], // Gas stations
  count: 5,
  maxRadius: 5000
});
```
- Defined in services/proximity.service.ts:47

findNearestByCategory

findNearestByCategory(
    center: Coordinate,
    categoryCode: string,
    count?: number,
): Promise<ProximityResult>
Finds the nearest POIs by a specific category code.
Parameters
- center: Coordinate
  Search center coordinate.
- categoryCode: string
  POI category code to search for.
- count: number = 5
  Maximum number of results (default: 5).
Returns Promise<ProximityResult>
Promise resolving to proximity search results.
Example
```
const results = await service.findNearestByCategory(
  { lat: 41.3851, lng: 2.1734 },
  'C014' // Restaurants
);
```
- Defined in services/proximity.service.ts:90

findNearestWithRouting

findNearestWithRouting(
    center: Coordinate,
    categoryCode: string,
    weight?: "time" | "distance",
    count?: number,
): Promise<ProximityResult>
Finds the nearest POIs with routing distance/time information.
Parameters
- center: Coordinate
  Search center coordinate.
- categoryCode: string
  POI category code to search for.
- weight: "time" | "distance" = 'time'
  Routing weight ('time' or 'distance').
- count: number = 5
  Maximum number of results (default: 5).
Returns Promise<ProximityResult>
Promise resolving to proximity search results with routing info.
Example
```
const results = await service.findNearestWithRouting(
  { lat: 41.3851, lng: 2.1734 },
  'C001', // Gas stations
  'time' // Sort by driving time
);
```
- Defined in services/proximity.service.ts:120

`Protected`request

request<T>(
    params: Record<string, string>,
    operationName?: string,
    baseUrl?: string,
): Promise<T>
Executes a generic request to the Cercalia API.
Type Parameters
- T
Parameters
- params: Record<string, string>
  Query parameters for the API request.
- operationName: string = 'Cercalia Request'
  Human-readable name for logging and debugging.
- OptionalbaseUrl: string
  Optional override for the base API URL.
Returns Promise<T>
A promise resolving to the parsed API response.
Throws
Error with code '30006' when no results are found.

Throws
Error for HTTP errors or invalid JSON responses.
Example
```
const response = await this.request<MyResponse>(
  { cmd: 'cand', adr: 'Gran Via 1' },
  'Geocoding'
);
```
Inherited from CercaliaClient.request
- Defined in services/cercalia-client.ts:68