@yandex/ymaps3-types
Version:
Types for ymaps3 maps library
37 lines (36 loc) • 899 B
TypeScript
/**
* All possible apikeys for http-services.
*/
interface Apikeys {
suggest?: string;
router?: string;
search?: string;
}
/**
* Configuration object for whole API.
* For example, it can be used to set experiments or apikeys.
* ```js
* ymaps3.getDefaultConfig().setApikeys({search: "YOUR_SEARCH_API_KEY"})`.
* ```
*/
export declare class Config {
readonly description: string;
/**
* Set experiments for map.
*/
setExperiments(experiments: Record<string, boolean>): void;
/**
* Set apikeys for http-services.
* ```js
* ymaps3.getDefaultConfig().setApikeys({search: "YOUR_SEARCH_API_KEY"})`.
* ```
*/
setApikeys(apikeys: Apikeys): void;
}
/**
* Returns default config object.
* ```js
* ymaps3.getDefaultConfig().setApikeys({suggest: "YOUR_SUGGEST_API_KEY"})`.
* ```
*/
export declare function getDefaultConfig(): Config;