1
0
mirror of https://github.com/twitter/twemoji.git synced 2024-10-01 12:24:23 +00:00

update types

This commit is contained in:
Alexey Molchan 2022-04-30 01:29:16 +03:00 committed by Justine De Caires
parent cf0abdf325
commit 47db606d06

15
index.d.ts vendored
View File

@ -7,9 +7,11 @@
* @param options all info for this parsing operation * @param options all info for this parsing operation
* @param variant the optional \uFE0F ("as image") variant, in case this info is anyhow meaningful. By default this is ignored. * @param variant the optional \uFE0F ("as image") variant, in case this info is anyhow meaningful. By default this is ignored.
*/ */
declare type ParseCallback = (icon: string, options: object, variant: string) => string | false; type ParseCallback = (icon: string, options: object, variant: string) => string | false;
declare interface TwemojiOptions { type Replacer = (substring: string, ...args: any[]) => string;
interface TwemojiOptions {
/** /**
* Default: MaxCDN * Default: MaxCDN
*/ */
@ -44,7 +46,11 @@ declare interface TwemojiOptions {
attributes?(icon: string, variant: string): object; attributes?(icon: string, variant: string): object;
} }
declare type Twemoji = { type Twemoji = {
base: string;
ext: string;
className: string;
size: string;
convert: { convert: {
/** /**
* Given an HEX codepoint, returns UTF16 surrogate pairs. * Given an HEX codepoint, returns UTF16 surrogate pairs.
@ -79,6 +85,9 @@ declare type Twemoji = {
toCodePoint(utf16surrogatePairs: string, sep?: string): string; toCodePoint(utf16surrogatePairs: string, sep?: string): string;
}; };
parse<T extends string | HTMLElement>(node: T, options?: TwemojiOptions | ParseCallback): T; parse<T extends string | HTMLElement>(node: T, options?: TwemojiOptions | ParseCallback): T;
replace(text: string, replacer: string | Replacer): string;
test(text: string): boolean;
onerror(): void;
}; };
declare module 'twemoji' { declare module 'twemoji' {