autocompleter-caba

Documentación del Paquete Autocompleter

Este paquete proporciona funcionalidades para obtener sugerencias e información para direcciones y sitios de interés de la Ciudad de Buenos Aires.

Instalación

Para instalar el paquete, utilizar npm:

npm install autocompleter-caba

Uso

Primero, importar el paquete:

import { Autocompleter } from "autocompleter";

Luego, crear una instancia de Autocompleter:

const autocompleter = new Autocompleter();

Configuración de Credenciales

Antes de utilizar las funciones de búsqueda, asegurarse de establecer las credenciales del cliente utilizando el método setCredentials(clientId, clientSecret):

autocompleter.setCredentials("tu_client_id", "tu_client_secret");

Habilitar/Desactivar Suggesters

Se puede habilitar o desactivar los suggesters según necesidades utilizando los métodos enableSuggester(suggester) y disableSuggester(suggester):

autocompleter.enableSuggester("AddressSuggester");
autocompleter.disableSuggester("PlaceSuggester");

Obtener Sugerencias

Para obtener sugerencias de los suggesters seleccionados según la entrada de texto del usuario, utilizar el método getSuggestions(input) (Ver en la sección Métodos los parámetros opcionales):

const suggestions = await autocompleter.getSuggestions("Callao 520");

Buscar Direcciones

Para buscar direcciones, utilizar el método getSearchAddress(address):

const searchResult = await autocompleter.getSearchAddress("Callao 520");

Buscar Lugares de Interés

Para buscar sitios de interés, utilizar el método getSearchPlaces(place):

const searchResult = await autocompleter.getSearchPlaces("hospital");

Buscar Información

Para buscar información sobre los Suggesters habilitados, utilizar el método getSearch(string_de_busqueda):

const searchResult = await autocompleter.getSearch("Callao 520");

Las siguientes funciones permiten a los usuarios interactuar con la aplicación Autocompleter de diversas maneras, desde configurar sus credenciales hasta obtener sugerencias y resultados de búsqueda específicos.

Métodos

• getClientId(): Devuelve el atributo clientId.

• getClientSecret(): Devuelve el atributo clientSecret.

• setCredentials(clientId: string, clientSecret: string): Permite establecer las credenciales del cliente proporcionando los atributos clientId y clientSecret.

• findSuggester(suggesterType: SuggestersOptions): Busca y devuelve el suggester correspondiente según el tipo especificado.

• enableSuggester(suggester: SuggestersOptions): Permite habilitar un suggester específico.

• disableSuggester(suggester: SuggestersOptions): Desactiva un suggester específico.

• getSuggesters(): Devuelve un objeto que contiene todos los suggesters disponibles en la aplicación.

• getSuggestions(input: string, typeSuggester: string): Busca sugerencias basadas en la entrada de texto proporcionada. TypeSuggester pueder ser "address" o "place", por dafault es "all".

• getSearch(input: string): Busca información sobre la dirección o sitio de interés ingresado.

• getSearchPlaces(place: string): Busca información del sitios de interés ingresado.

• getSearchAddress(address: string): Busca información de la dirección ingresada.

Notas

• Asegurarse de establecer las credenciales del cliente antes de realizar cualquier búsqueda.
• Los suggesters deben estar habilitados antes de utilizar las funciones de búsqueda correspondientes.
• El paquete tiene restricciones en cuanto a la longitud mínima de texto y el número máximo de sugerencias.