@types/ellipsize

ellipsize.d.ts

/**
 * custom ellipsize typings - tested with ellipsize@0.1.0
 */
declare module 'ellipsize' {
  /**
   * @param text text to ellipsize
   * @param maxLength of the text before it is ellipsized
   * @param options
   */
  function ellipsize(
    text: string,
    maxLength: number,
    options: {
      /**
       * breakpoints - after this char the ellipse can be rendered
       */
      chars?: string[]
      /**
       * custom ellipse element
       * @default '...'
       */
      ellipse?: string
      /**
       * truncate words or not
       * @default: true
       */
      truncate?: boolean
    },
  ): string

  export default ellipsize
}