mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-04-16 22:40:01 +08:00
106 lines
4.1 KiB
TypeScript
106 lines
4.1 KiB
TypeScript
// Type definitions for twitter-text v1.13.4
|
|
// Project: https://github.com/twitter/twitter-text
|
|
// Definitions by: rhysd <https://rhysd.github.io>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
|
|
export interface HashtagWithIndices {
|
|
hashtag: string;
|
|
indices: [number, number];
|
|
}
|
|
export interface UrlWithIndices {
|
|
url: string;
|
|
indices: [number, number];
|
|
}
|
|
export interface MentionWithIndices {
|
|
screenName: string;
|
|
indices: [number, number];
|
|
}
|
|
export interface MentionOrListWithIndices {
|
|
screenName: string;
|
|
listSlug: string;
|
|
indices: [number, number];
|
|
}
|
|
export interface CashtagWithIndices {
|
|
cashtag: string;
|
|
indices: [number, number];
|
|
}
|
|
export type EntityWithIndices =
|
|
HashtagWithIndices |
|
|
UrlWithIndices |
|
|
MentionWithIndices |
|
|
MentionOrListWithIndices |
|
|
CashtagWithIndices;
|
|
|
|
interface Indices {
|
|
indices: [number, number];
|
|
}
|
|
|
|
export declare function htmlEscape(text: string): string;
|
|
export declare function splitTags(text: string): string[];
|
|
|
|
export declare function extractHashtags(text: string): string[];
|
|
export declare function extractHashtagsWithIndices(text: string): HashtagWithIndices[];
|
|
export declare function extractUrls(text: string): string[];
|
|
export declare function extractUrlsWithIndices(text: string): UrlWithIndices[];
|
|
export declare function extractMentions(text: string): string[];
|
|
export declare function extractMentionsWithIndices(text: string): MentionWithIndices[];
|
|
export declare function extractMentionsOrListsWithIndices(text: string): MentionOrListWithIndices[];
|
|
export declare function extractReplies(text: string): string[];
|
|
export declare function extractCashtags(text: string): string[];
|
|
export declare function extractCashtagsWithIndices(text: string): CashtagWithIndices[];
|
|
export declare function extractEntitiesWithIndices(text: string): EntityWithIndices[];
|
|
|
|
export declare function modifyIndicesFromUnicodeToUTF16<I>(i: I): I;
|
|
export declare function modifyIndicesFromUTF16ToUnicode<I>(i: I): I;
|
|
|
|
export interface UrlEntity {
|
|
url: string;
|
|
display_url: string;
|
|
expanded_url: string;
|
|
indices: [number, number];
|
|
}
|
|
export interface AutoLinkOptions {
|
|
hashtagClass?: string;
|
|
hashtagUrlBase?: string;
|
|
cashtagClass?: string;
|
|
cashtagUrlBase?: string;
|
|
listClass?: string;
|
|
usernameClass?: string;
|
|
usernameUrlBase?: string;
|
|
listUrlBase?: string;
|
|
htmlAttrs?: string;
|
|
invisibleTagAttrs?: string;
|
|
htmlEscapeNonEntities?: boolean;
|
|
targetBlank?: boolean;
|
|
suppressNoFollow?: boolean;
|
|
urlEntities?: UrlEntity[];
|
|
}
|
|
|
|
export declare function autoLink(text: string, options?: AutoLinkOptions): string;
|
|
export declare function autoLinkUsernamesOrLists(text: string, options?: AutoLinkOptions): string;
|
|
export declare function autoLinkHashtags(text: string, options?: AutoLinkOptions): string;
|
|
export declare function autoLinkCashtags(text: string, options?: AutoLinkOptions): string;
|
|
export declare function autoLinkUrlsCustom(text: string, options?: AutoLinkOptions): string;
|
|
export declare function autoLinkEntities(text: string, entities: EntityWithIndices[], options?: AutoLinkOptions): string;
|
|
|
|
interface TweetLengthOptions {
|
|
short_url_length: number;
|
|
short_url_length_https: number;
|
|
}
|
|
export declare function getTweetLength(text: string, options?: TweetLengthOptions): number;
|
|
|
|
export declare function isValidUsername(username: string): boolean;
|
|
export declare function isValidList(usernameList: string): boolean;
|
|
export declare function isValidHashtag(hashtag: string): boolean;
|
|
// Note: unicodeDomainsa and requireProtocol can be null
|
|
export declare function isValidUrl(url: string, unicodeDomains: boolean, requireProtocol: boolean): boolean;
|
|
export declare function hasInvalidCharacters(text: string): boolean;
|
|
export declare function isInvalidTweet(text: string): string;
|
|
|
|
export declare function getUnicodeTextLength(text: string): number;
|
|
// Note: This function directly modify entities" indices
|
|
export declare function convertUnicodeIndices(text: string, entities: EntityWithIndices[], indicesInUTF16?: boolean): void;
|
|
|
|
export declare function hitHighlight(text: string, hits?: number[][], options?: { tag: string }): string;
|