@placeme/ngx-geo-api-gouv-adress v1.0.0

@placeme/ngx-geo-api-gouv-adress

Introduction

@placeme/ngx-geo-api-gouv-adress is the Angular module to use the Geo Api of the French government.

See the REST api definition : https://geo.api.gouv.fr/adresse.

Maintainer

https://www.placeme.io/

Installation

First you need to install the npm module:

npm install @placeme/ngx-geo-api-gouv-adress --save
npm install geojson --save

Usage

1. Import the GeoApiGouvAdressModule:

Finally, you can use ngx-translate in your Angular project. You have to import GeoApiGouvAdressModule.forRoot() in the root NgModule of your application.

The forRoot static method is a convention that provides and configures services at the same time. Make sure you only call this method in the root module of your application, most of the time called AppModule.

import { NgModule } from "@angular/core";
import { CommonModule } from "@angular/common";
import { GeoApiGouvAdressModule } from "@placeme/ngx-geo-api-gouv-adress";

import { AppComponent } from "./app.component";

@NgModule({
  declarations: [AppComponent],
  imports: [CommonModule, GeoApiGouvAdressModule.forRoot()],
})
export class AppModule {}

2. Use the GeoApiGouvAdressService:

import { Component, OnInit } from "@angular/core";
import {
  GeoApiGouvAdressResponse,
  GeoApiGouvAdressService,
} from "@placeme/ngx-geo-api-gouv-adress";

@Component({
  selector: "app-root",
  templateUrl: "./app.component.html",
  styleUrls: ["./app.component.scss"],
})
export class AppComponent implements OnInit {
  constructor(private geoApiGouvAdressService: GeoApiGouvAdressService) {}

  ngOnInit(): void {
    // Search API
    this.geoApiGouvAdressService
      .query({ q: "27 rue des Blanchers, 31000 Toulouse" })
      .subscribe((geoApiGouvAdressResponse: GeoApiGouvAdressResponse) => {
        console.log(geoApiGouvAdressResponse);
      });

    // Reverse API
    this.geoApiGouvAdressService
      .reverse({ lat: 43.602508, lon: 1.437591 })
      .subscribe((geoApiGouvAdressResponse: GeoApiGouvAdressResponse) => {
        console.log(geoApiGouvAdressResponse);
      });
  }
}

4. See the interface QueryRequestParams:

interface QueryRequestParams {
  q: string;
  limit?: number;
  autocomplete?: number;
  lat?: number;
  lon?: number;
  type?: GeoApiGouvAdressType;
  postcode?: string;
  citycode?: string;
}

5. See the interface ReverseRequestParams:

interface ReverseRequestParams {
  lat: number;
  lon: number;
  type?: GeoApiGouvAdressType;
}

6. See the interface GeoApiGouvAdressResponse:

import { Feature, FeatureCollection } from "geojson";

export type GeoApiGouvAdressType =
  | "housenumber"
  | "street"
  | "locality"
  | "municipality";

export interface GeoApiGouvAdress {
  id: string;
  type: GeoApiGouvAdressType;
  score: number;
  housenumber?: string;
  name?: string;
  postcode: string;
  citycode: string;
  city: string;
  district?: string;
  oldcitycode?: string;
  oldcity?: string;
  context: string;
  label: string;
  x: number;
  y: number;
  importance: number;
}

export interface GeoApiGouvAdressFeatureCollection extends Feature {
  properties: GeoApiGouvAdress;
}

export interface GeoApiGouvAdressResponse extends FeatureCollection {
  features: GeoApiGouvAdressFeatureCollection[];
}