Skip to main content

A module to truncate the string with the specify length; Safe with the emojis, URLs, and words.

Works with
This package works with Bun
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
It is unknown whether this package works with Browsers
JSR Score
100%
Published
2 weeks ago (2.0.3)

String Overflow (ES)

⚖ī¸ MIT

GitHub: hugoalh-studio/string-overflow-es JSR: @hugoalh/string-overflow NPM: @hugoalh/string-overflow

An ES (JavaScript & TypeScript) module to truncate the string with the specify length; Safe with the emojis, URLs, and words.

🔰 Begin

đŸŽ¯ Targets

Registry - JSR Registry - NPM Remote Import
Bun >= v1.1.0 ✔ī¸ node_modules ✔ī¸ Specifier npm: ❌
Cloudflare Workers ✔ī¸ node_modules ✔ī¸ node_modules ❌
Deno >= v1.42.0 ✔ī¸ Specifier jsr: ✔ī¸ Specifier npm: ✔ī¸
NodeJS >= v20.9.0 ✔ī¸ node_modules ✔ī¸ node_modules ❌

ℹī¸ Note

It is possible to use this module in other methods/ways which not listed in here, however it is not officially supported.

#ī¸âƒŖ Registries Identifier

  • JSR:
    @hugoalh/string-overflow
    
  • NPM:
    @hugoalh/string-overflow
    

ℹī¸ Note

  • Although it is recommended to import the entire module, it is also able to import part of the module with sub path if available, please visit file jsr.jsonc property exports for available sub paths.
  • It is recommended to use this module with tag for immutability.

#ī¸âƒŖ Remote Import Paths

  • GitHub Raw: (Require Tag)
    https://raw.githubusercontent.com/hugoalh-studio/string-overflow-es/${Tag}/mod.ts
    

ℹī¸ Note

  • Although it is recommended to import the entire module with the main path mod.ts, it is also able to import part of the module with sub path if available, but do not import if:

    • it's file path has an underscore prefix (e.g.: _foo.ts, _util/bar.ts), or
    • it is a benchmark or test file (e.g.: foo.bench.ts, foo.test.ts), or
    • it's symbol has an underscore prefix (e.g.: export function _baz() {}).

    These elements are not considered part of the public API, thus no stability is guaranteed for them.

  • Although there have 3rd party services which provide enhanced, equal, or similar methods/ways to remote import the module, beware these services maybe inject unrelated elements and thus affect the security.

🛡ī¸ Permissions

This module does not require any permission.

🧩 APIs

  • class StringTruncator {
      constructor(maximumLength: number, options: StringTruncatorOptions = {}): StringTruncator;
      truncate(item: string, maximumLengthOverride?: number): string;
      static truncate(item: string, maximumLength: number, options: StringTruncatorOptions = {}): string;
    }
    
  • function truncateString(item: string, maximumLength: number, options: StringTruncatorOptions = {}): string;
    
  • enum StringTruncateEllipsisPosition {
      end = "end",
      End = "end",
      middle = "middle",
      Middle = "middle",
      start = "start",
      Start = "start"
    }
    
  • interface StringTruncatorOptions extends StringDissectorOptions {
      /**
      * Ellipsis mark of the target string.
      * @default "..."
      */
      ellipsisMark?: string;
      /**
      * Ellipsis position at the target string.
      * @default "end"
      */
      ellipsisPosition?: StringTruncateEllipsisPosition | keyof typeof StringTruncateEllipsisPosition;
    }
    

ℹī¸ Note

For the prettier documentation, can visit via:

✍ī¸ Examples

  • const text = "Vel ex sit est sit est tempor enim et voluptua consetetur gubergren gubergren ut. Amet dolores sit. Duo iriure vel dolore illum diam. Ea vero diam diam tincidunt molestie elitr te sed nisl ut vulputate tincidunt accusam sit sed. Amet sea dolore rebum amet accusam labore dolor no sadipscing labore. Sit erat sit sed voluptua tempor sit ea dolor et.";
    
    /* Either */
    new StringTruncator(100).truncate(text);
    truncateString(text, 100);
    //=> "Vel ex sit est sit est tempor enim et voluptua consetetur gubergren gubergren ut. Amet dolores ..."
    
    /* Either */
    new StringTruncator(100, { safeWords: false }).truncate(text);
    truncateString(text, 100, { safeWords: false });
    //=> "Vel ex sit est sit est tempor enim et voluptua consetetur gubergren gubergren ut. Amet dolores si..."
    
Built and signed on
GitHub Actions
View transparency log

Add Package

deno add @hugoalh/string-overflow

Import symbol

import * as mod from "@hugoalh/string-overflow";

Add Package

npx jsr add @hugoalh/string-overflow

Import symbol

import * as mod from "@hugoalh/string-overflow";

Add Package

yarn dlx jsr add @hugoalh/string-overflow

Import symbol

import * as mod from "@hugoalh/string-overflow";

Add Package

pnpm dlx jsr add @hugoalh/string-overflow

Import symbol

import * as mod from "@hugoalh/string-overflow";

Add Package

bunx jsr add @hugoalh/string-overflow

Import symbol

import * as mod from "@hugoalh/string-overflow";