Skip to content

Commit da8e67a

Browse files
committed
Better doc
1 parent 1e48b16 commit da8e67a

File tree

1 file changed

+2
-1
lines changed
  • packages/element-web-module-api/src/api

1 file changed

+2
-1
lines changed

packages/element-web-module-api/src/api/i18n.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@ export interface I18nApi {
5151
translate(key: keyof Translations, variables?: Variables): string;
5252

5353
/**
54-
* Convert a timestamp into a human-readable time string
54+
* Convert a timestamp into a translated, human-readable time,
55+
* using the current system time as a reference, eg. "5 minutes ago".
5556
* @param timeMillis - The time in milliseconds since epoch
5657
*/
5758
humanizeTime(timeMillis: number): string;

0 commit comments

Comments
 (0)