From 4915b607329b17eee7c18153f4da3c8b3370a261 Mon Sep 17 00:00:00 2001 From: Matt Lewis Date: Thu, 28 Dec 2017 10:19:23 +0000 Subject: [PATCH] Feedback from code review --- types/twitter-text/index.d.ts | 15 ++++++++++++++- types/twitter-text/twitter-text-tests.ts | 3 +++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/types/twitter-text/index.d.ts b/types/twitter-text/index.d.ts index 746def795a..977aa03049 100644 --- a/types/twitter-text/index.d.ts +++ b/types/twitter-text/index.d.ts @@ -113,6 +113,19 @@ export declare function convertUnicodeIndices(text: string, entities: EntityWith export declare function hitHighlight(text: string, hits?: number[][], options?: { tag: string }): string; +export interface ParseTweetOptions { + version?: number; + maxWeightedTweetLength?: number; + scale?: number; + defaultWeight?: number; + transformedURLLength?: number; + ranges?: Array<{ + start: number; + end: number; + weight: number; + }>; +} + export interface ParsedTweet { weightedLength: number; permillage: number; @@ -123,4 +136,4 @@ export interface ParsedTweet { validRangeStart: number; } -export declare function parseTweet(text: string): ParsedTweet; +export declare function parseTweet(text: string, options?: ParseTweetOptions): ParsedTweet; diff --git a/types/twitter-text/twitter-text-tests.ts b/types/twitter-text/twitter-text-tests.ts index a8e198e410..fdf816ec8f 100644 --- a/types/twitter-text/twitter-text-tests.ts +++ b/types/twitter-text/twitter-text-tests.ts @@ -60,3 +60,6 @@ const linked: string = twitter.autoLink("link @user, and expand url... http://t. ]}); const usernames: string[] = twitter.extractMentions("Mentioning @twitter and @jack"); + +const tweet = twitter.parseTweet('foo'); +const tweetWithOptions = twitter.parseTweet('foo', {maxWeightedTweetLength: 140});