libpostal

Présentation

Ce plugin est propose une série d'instructions pour utiliser libpostal

installation

``bash
npm install @ezs/libpostal
`

usage

#### Table of Contents

* expandAddress
* expandAddressWith
* parseAddress
* parseAddressWith

$3

Try to normalize given addresss.

Essaye de normaliser les adresses données.

#### Example / Exemple

##### Script / Scénario

`ini
; Import libpostal plugin required to use "expandAddress"
; Importation du plugin libpostal nécessaire pour utiliser "expandAddress"
[use]
plugin = libpostal

; Using "expandAddress"
; Utilisation de "expandAddress"
[expandAddress]

`

##### Input / Entrée

`json
[
"Barboncino 781 Franklin Ave, Crown Heights, Brooklyn, NY 11238"
]
`

##### Output / Sortie

`json
[
{
"id": "Barboncino 781 Franklin Ave, Crown Heights, Brooklyn, NY 11238",
"value": [
"barboncino 781 franklin avenue crown heights brooklyn ny 11238",
"barboncino 781 franklin avenue crown heights brooklyn new york 11238"
]
}
]
`

#### Parameters

* input (String | Array<String> | Object)

Returns ({id: String, value: Array<String>} | Array<{id: String, value: Array<String>}> | Object)

$3

Try to normalize given addresss.

Essaye de normaliser les adresses données.

#### Example / Exemple

##### Script / Scénario

`ini
; Import libpostal plugin required to use "expandAddressWith"
; Importation du plugin libpostal nécessaire pour utiliser "expandAddressWith"
[use]
plugin = libpostal

; Using "expandAddressWith"
; Utilisation de "expandAddressWith"
[expandAddress]
; path = value

`

##### Input / Entrée

`json
[
{
"value": "Barboncino 781 Franklin Ave, Crown Heights, Brooklyn, NY 11238"
}
]
`

##### Output / Sortie

`json
[
{
"value": {
"id": "Barboncino 781 Franklin Ave, Crown Heights, Brooklyn, NY 11238",
"value": [
"barboncino 781 franklin avenue crown heights brooklyn ny 11238",
"barboncino 781 franklin avenue crown heights brooklyn new york 11238"
]
}
}
]
`

#### Parameters

* input ({path: Array<string>} | Array<{path: Array<string>}> | Object)
* path String

• path of the element to expand

• chemin de l'élément à etandre

(optional, default value)

Returns ({path: {id: string, value: Array<string>}} | Array<{path: {id: string, value: Array<string>}}> | Object)

$3

Try to parse given addresss.

Essaye de faire l'analyse grammaticale des adresses données.

#### Example / Exemple

##### Script / Scénario

`ini
; Import libpostal plugin required to use "parseAddress"
; Importation du plugin libpostal nécessaire pour utiliser "parseAddress"
[use]
plugin = libpostal

; Using "parseAddress"
; Utilisation de "parseAddress"
[parseAddress]

`

##### Input / Entrée

`json
[
"Barboncino 781 Franklin Ave, Crown Heights, Brooklyn, NY 11238"
]
`

##### Output / Sortie

`json
[
{
"id": "Barboncino 781 Franklin Ave, Crown Heights, Brooklyn, NY 11238",
"value": {
"house": "barboncino",
"house_number": "781",
"road": "franklin ave",
"suburb": "crown heights",
"city_district": "brooklyn",
"state": "ny",
"postcode": "11238"
}
}
]
`

#### Parameters

* input (String | Array<String> | Object)

Returns ({id: String, value: Object} | Array<{id: String, value: Object}> | Object)

$3

Try to parse given addresss.

Essaye de faire l'analyse grammaticale des adresses données.

#### Example / Exemple

##### Script / Scénario

`ini
; Import libpostal plugin required to use "parseAddressWith"
; Importation du plugin libpostal nécessaire pour utiliser "parseAddressWith"
[use]
plugin = libpostal

; Using "parseAddressWith"
; Utilisation de "parseAddressWith"
[expandAddress]
; path = value

`

##### Input / Entrée

`json
[
{
"value": "Barboncino 781 Franklin Ave, Crown Heights, Brooklyn, NY 11238"
}
]
`

##### Output / Sortie

`json
[
{
"value": {
"id": "Barboncino 781 Franklin Ave, Crown Heights, Brooklyn, NY 11238",
"value": {
"house": "barboncino",
"house_number": "781",
"road": "franklin ave",
"suburb": "crown heights",
"city_district": "brooklyn",
"state": "ny",
"postcode": "11238"
}
}
}
]
`

#### Parameters

* input ({path: Array<string>} | Array<{path: Array<string>}> | Object)
* path String

• path of the element to parse

• chemin de l'élément à analyser

(optional, default value`)

Returns ({path: {id: string, value: Object}} | Array<{path: {id: string, value: Object}}> | Object)