places-autocomplete-svelte/dist/helpers.d.ts

A flexible, accessible, and secure Svelte component leveraging the Google Maps Places Autocomplete API (New) to provide a user-friendly way to search for and retrieve detailed address information.

import type { RequestParams, ComponentOptions, ComponentClasses, DistanceUnits } from './interfaces.js';
/**
 * Default request parameters
 */
export declare const requestParamsDefault: RequestParams;
/**
 * Default fetch fields values
 * https://developers.google.com/maps/documentation/javascript/place-class-data-fields
 *
 * unsupported field values
 * geometry, icon, name, permanentlyClosed, photo, placeId, url, utcOffset, vicinity, openingHours, icon, name
 */
export declare const defaultFetchFields: Array<string>;
/**
 * Validate and cast request parameters
 * @param requestParams
 */
export declare const validateRequestParams: (requestParams: RequestParams | undefined) => RequestParams;
/**
 * Validate fetchFields array parameters
 * @param fetchFields
 */
export declare const validateFetchFields: (fetchFields: Array<string> | undefined) => string[];
/**
 * Default component classes
 */
export declare const componentClasses: ComponentClasses;
/**
 * Default component options
 */
export declare const componentOptions: ComponentOptions;
/**
 * Validate and cast component options
 * @param options
 */
export declare const validateOptions: (options: ComponentOptions | undefined) => ComponentOptions;
/**
 * Display distance in km or miles
 * @param distance
 * @param units
 * @returns
 */
export declare const formatDistance: (distance: number, units: DistanceUnits) => string | null;
/**
 * Create highlighted segments from the original text based on the provided matches.
 * @param originalText The original text to segment.
 * @param matches An array of match objects containing start and end offsets.
 * @returns An array of text segments with highlighting information.
 */
export declare function createHighlightedSegments(originalText: string, matches: {
    startOffset: number;
    endOffset: number;
}[]): {
    text: string;
    highlighted: boolean;
}[];
/**
 * Debounce function that takes a function and a delay
 * and returns a new function that will only execute
 * after the delay has passed without any new calls.
 * This version is generic and preserves the types of the original function.
 * @param func The function to debounce.
 * @param delay The debounce delay in milliseconds.
 */
export declare const debounce: <T extends (...args: any[]) => void>(func: T, delay: number) => (...args: Parameters<T>) => void;