Skip to main content
Home
Browse packagesDocsSign in

@hugoalh/string-overflow@2.1.0
Built and signed on GitHub Actions

latest
hugoalh/string-overflow-es

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

This package works with DenoIt is unknown whether this package works with Cloudflare Workers, Node.js, Bun
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
This package works with Deno
It is unknown whether this package works with Bun
JSR Score
88%
Published
4 months ago (2.1.0)

String Overflow (ES)

⚖️ MIT

GitHub: hugoalh/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

Remote JSR NPM
Bun >= v1.1.0 ❌ ❓ ✔️
Cloudflare Workers ❌ ❓ ✔️
Deno >= v1.42.0 ✔️ ✔️ ✔️
NodeJS >= v20.9.0 ❌ ❓ ✔️
Note

  • It is possible to use this module in other methods/ways which not listed in here, however those methods/ways are not officially supported, and should beware maybe cause security issues.

#️⃣ Resources Identifier

  • Remote - 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}]
Note

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

    • it's 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.: _bar, _foo).

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

  • For usage of JSR or NPM resources, it is recommended to import the entire module with the main entrypoint, however it is also able to import part of the module with sub entrypoint if available, please visit the file jsr.jsonc property exports for available sub entrypoints.

  • It is recommended to use this module with tag for immutability.

🛡️ Runtime Permissions

This module does not request any runtime permission.

🧩 APIs

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

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

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

✍️ 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..."
Built and signed on
GitHub Actions
View transparency log

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@hugoalh/string-overflow

Import symbol

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

Import directly with a jsr specifier

import * as string_overflow from "jsr:@hugoalh/string-overflow";

Add Package

pnpm i jsr:@hugoalh/string-overflow
or (using pnpm 10.8 or older)
pnpm dlx jsr add @hugoalh/string-overflow

Import symbol

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

Add Package

yarn add jsr:@hugoalh/string-overflow
or (using Yarn 4.8 or older)
yarn dlx jsr add @hugoalh/string-overflow

Import symbol

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

Add Package

npx jsr add @hugoalh/string-overflow

Import symbol

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

Add Package

bunx jsr add @hugoalh/string-overflow

Import symbol

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