An ES (JavaScript & TypeScript) module to truncate the string with the specify length; Safe with the emojis, URLs, and words.
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.
- 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
propertyexports
for available sub paths.- It is recommended to use this module with tag for immutability.
- 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.
This module does not require any permission.
-
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:
-
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..."