@hugoalh/string-overflow

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

https://github.com/hugoalh/string-overflow-es

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (7.3%) to scientific vocabulary

Keywords

ecmascript ecmascript-module es es-module esm esmodule javascript js overflow string truncate ts typescript

Last synced: 6 months ago · JSON representation ·

Repository

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

Basic Info

Host: GitHub
Owner: hugoalh
License: other
Language: TypeScript
Default Branch: main
Homepage:
Size: 103 KB

Statistics

Stars: 1
Watchers: 1
Forks: 0
Open Issues: 2
Releases: 6

Topics

ecmascript ecmascript-module es es-module esm esmodule javascript js overflow string truncate ts typescript

Created almost 2 years ago · Last pushed 6 months ago

Metadata Files

Readme Contributing License Citation Codeowners Security

README.md

String Overflow (ES)

⚖️ MIT

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

🔰 Begin

🎯 Targets

| Targets | Remote | JSR | NPM | |:--|:-:|:-:|:-:| | Bun >= v1.1.0 | ❌ | ✔️ | ✔️ | | Deno >= v2.1.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

ts class StringTruncator { constructor(maximumLength: number, options?: StringTruncatorOptions); truncate(item: string, maximumLengthOverride?: number): string; }
ts type StringTruncateEllipsisPosition = | "end" | "middle" | "start";
ts interface StringTruncatorOptions extends StringDissectorOptions { ellipsisMark?: string; ellipsisPosition?: StringTruncateEllipsisPosition; }

[!NOTE] - For the full or prettier documentation, can visit via: - Deno CLI deno doc - JSR

✍️ Examples

```ts 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..." ```

Owner

Name: hugoalh
Login: hugoalh
Kind: user
Location: Everywhere
Company: @hugoalh-studio

Twitter: hugoalhofficial
Repositories: 12
Profile: https://github.com/hugoalh

Lead of @hugoalh-studio; Full time software developer; Part time freelancer

Citation (CITATION.cff)

# yaml-language-server: $schema=https://citation-file-format.github.io/1.2.0/schema.json
cff-version: "1.2.0"
title: "String Overflow (ES)"
message: "If you use this software, please cite it using the metadata from this file."
type: "software"
authors:
  - name: "hugoalh"
repository-code: "https://github.com/hugoalh/string-overflow-es"
keywords:
  - "ecmascript"
  - "ecmascript-module"
  - "es"
  - "es-module"
  - "esm"
  - "esmodule"
  - "javascript"
  - "js"
  - "overflow"
  - "string"
  - "truncate"
  - "ts"
  - "typescript"
license: "MIT"

GitHub Events

Total

Release event: 2
Delete event: 2
Issue comment event: 1
Push event: 12
Pull request event: 4
Create event: 5

Last Year

Release event: 2
Delete event: 2
Issue comment event: 1
Push event: 12
Pull request event: 4
Create event: 5

Committers

Last synced: 10 months ago

All Time

Total Commits: 18
Total Committers: 1
Avg Commits per committer: 18.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 14
Committers: 1
Avg Commits per committer: 14.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
hugoalh	h**h@g**m	18

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 0
Total pull requests: 3
Average time to close issues: N/A
Average time to close pull requests: 20 days
Total issue authors: 0
Total pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 1.0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 3

Past Year

Issues: 0
Pull requests: 3
Average time to close issues: N/A
Average time to close pull requests: 20 days
Issue authors: 0
Pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 1.0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 3

View more stats

Top Authors

Issue Authors

Pull Request Authors

dependabot[bot] (6)

Top Labels

Issue Labels

Pull Request Labels

Type/Dependency 📦 (5) Platform/GitHubActions (5) Status/Pending 🔵 (4) dependency 📦 (1) github-actions (1)

Packages

Total packages: 1
Total downloads:
- npm 113 last-month

Total dependent packages: 0
Total dependent repositories: 17
Total versions: 13
Total maintainers: 1

npmjs.org: @hugoalh/string-overflow

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

Homepage: https://github.com/hugoalh/string-overflow-es#readme
License: MIT
Latest release: 2.1.1
published 7 months ago

Versions: 13
Dependent Packages: 0
Dependent Repositories: 17
Downloads: 113 Last month

Rankings

Dependent repos count: 2.9%

Forks count: 15.4%

Stargazers count: 16.7%

Average: 22.6%

Downloads: 26.4%

Dependent packages count: 51.8%

Maintainers (1)

hugoalh

Last synced: 6 months ago

Dependencies

.github/workflows/announce-new-release.yml actions

hugoalh/send-discord-webhook-ghaction v6.0.2 composite

.github/workflows/invoke-codeql-analysis.yml actions

.github/workflows/publish-deno-package.yml actions

.github/workflows/review-deno-code.yml actions

.github/workflows/scan-virus.yml actions

.github/workflows/sync-labels.yml actions