String Overflow (ES)

⚖️ MIT

🔗 DistBoard @hugoalh ● GitHub ● JSR ● NPM

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

🎯 Runtime Targets

Any runtime which support ECMAScript should able to use this; These runtimes are officially supported:

• Bun >= v1.1.0
• Deno >= v2.1.0
• NodeJS >= v20.9.0

🛡️ Runtime Permissions

This does not request any runtime permission.

#️⃣ Sources & Entrypoints

• GitHub Raw

  https://raw.githubusercontent.com/hugoalh/string-overflow-es/{Tag}/mod.ts

• JSR

  jsr:@hugoalh/string-overflow[@{Tag}]

• NPM

  npm:@hugoalh/string-overflow[@{Tag}]

| Name | Path | Description | |:--|:--|:--| | . | ./mod.ts | Default. |

[!NOTE]

• Different runtimes have vary support for the sources and entrypoints, visit the runtime documentation for more information.
• It is recommended to include tag for immutability.
• These are not part of the public APIs hence should not be used:
  • Benchmark/Test file (e.g.: example.bench.ts, example.test.ts).
  • Entrypoint name or path include any underscore prefix (e.g.: _example.ts, foo/_example.ts).
  • Identifier/Namespace/Symbol include any underscore prefix (e.g.: _example, Foo._example).

🧩 APIs

• class StringTruncator {
    constructor(maximumLengthDefault: number, options?: StringTruncatorOptions);
    truncate(item: string, maximumLengthOverride?: number): string;
  }

• type StringTruncateEllipsisPosition = 
    | "end"
    | "middle"
    | "start";

• interface StringTruncatorOptions extends StringDissectorOptions {
    ellipsisMark?: string;
    ellipsisPosition?: StringTruncateEllipsisPosition;
  }

[!NOTE]

• For the full or prettier documentation, can visit via:
  • Deno CLI deno doc
  • JSR

✍️ 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.";
  
  new StringTruncator(100).truncate(text);
  //=> "Vel ex sit est sit est tempor enim et voluptua consetetur gubergren gubergren ut. Amet dolores..."
  
  new StringTruncator(100, { safeWords: false }).truncate(text);
  //=> "Vel ex sit est sit est tempor enim et voluptua consetetur gubergren gubergren ut. Amet dolores si..."