emojibase
Version:
Emojibase utility functions for working with emoji characters.
14 lines • 642 B
TypeScript
import type { FetchFromCDNOptions, Locale, ShortcodePreset, ShortcodesDataset } from './types';
/**
* Fetches and returns localized shortcodes for the defined preset from our CDN.
* The response is a mapping of emoji hexcodes to shortcodes (either a string or array of strings).
* Uses `fetchFromCDN` under the hood.
*
* ```ts
* import { fetchShortcodes } from 'emojibase';
*
* await fetchShortcodes('ja', 'cldr', { version: '2.1.3' });
* ```
*/
export declare function fetchShortcodes(locale: Locale, preset: ShortcodePreset, options?: FetchFromCDNOptions): Promise<ShortcodesDataset>;
//# sourceMappingURL=fetchShortcodes.d.ts.map