clean-jsdoc-theme TypeDoc APIv0.0.0

truncate

truncate(str: string, maxLength: number, suffix: string): string

Source: string.ts:131

Truncates a string to a specified length

Parameters

  • str (string) — The input string
  • maxLength (number) — Maximum length of the result
  • suffix (string, default: "'...'") — Suffix to append if truncated

Returns

  • string — Truncated string

Example

CODE
truncate('Hello World', 5) // 'Hello...'
truncate('Hello World', 5, '…') // 'Hello…'
truncate('Hi', 10) // 'Hi'