osm-api
Version:
🗺️🌏 Javascript/Typescript wrapper around the OpenStreetMap API
17 lines (16 loc) • 650 B
TypeScript
type Config = {
/** the base URL for the OSM API. Defaults to `https://api.openstreetmap.org` */
apiUrl: string;
/** the HTTP User-Agent sent with every API request */
userAgent: string;
/** If you use another library for authentication, you can pass in a custom value for the `Authorization` HTTP header */
authHeader?: string;
/** Credentials if you want to login with basic auth (**strongly discouraged**) */
basicAuth?: {
username: string;
password: string;
};
};
export declare const getConfig: () => Config;
export declare function configure(updatedConfig: Partial<Config>): void;
export {};