https://github.com/hugoalh/string-dissect-es
An ECMAScript module to dissect the string; Safe with the emojis, URLs, and words.
https://github.com/hugoalh/string-dissect-es
dissect ecmascript ecmascript-module es es-module esm esmodule javascript js string ts typescript
Last synced: about 13 hours ago
JSON representation
An ECMAScript module to dissect the string; Safe with the emojis, URLs, and words.
- Host: GitHub
- URL: https://github.com/hugoalh/string-dissect-es
- Owner: hugoalh
- License: other
- Created: 2024-03-11T09:06:33.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-15T22:41:05.000Z (about 1 month ago)
- Last Synced: 2026-01-11T17:05:01.537Z (16 days ago)
- Topics: dissect, ecmascript, ecmascript-module, es, es-module, esm, esmodule, javascript, js, string, ts, typescript
- Language: TypeScript
- Homepage:
- Size: 107 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# String Dissect (ES)
[**⚖️** MIT](./LICENSE.md)
[](https://github.com/hugoalh/string-dissect-es)
[](https://jsr.io/@hugoalh/string-dissect)
[](https://www.npmjs.com/package/@hugoalh/string-dissect)
An ECMAScript module to dissect the string; Safe with the emojis, URLs, and words.
## 🎯 Targets
| **Runtime \\ Source** | **GitHub Raw** | **JSR** | **NPM** |
|:--|:-:|:-:|:-:|
| **[Bun](https://bun.sh/)** >= v1.1.0 | ❌ | ✔️ | ✔️ |
| **[Deno](https://deno.land/)** >= v2.1.0 | ✔️ | ✔️ | ✔️ |
| **[NodeJS](https://nodejs.org/)** >= v20.9.0 | ❌ | ✔️ | ✔️ |
## 🛡️ Runtime Permissions
This does not request any runtime permission.
## #️⃣ Sources
- GitHub Raw
```
https://raw.githubusercontent.com/hugoalh/string-dissect-es/{Tag}/mod.ts
```
- JSR
```
jsr:@hugoalh/string-dissect[@{Tag}]
```
- NPM
```
npm:@hugoalh/string-dissect[@{Tag}]
```
> [!NOTE]
> - 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`).
## ⤵️ Entrypoints
| **Name** | **Path** | **Description** |
|:--|:--|:--|
| `.` | `./mod.ts` | Default. |
## 🧩 APIs
- ```ts
class StringDissector {
constructor(options?: StringDissectorOptions);
dissect(item: string): Generator;
}
```
- ```ts
interface StringDissectorOptions {
locales?: Intl.LocalesArgument;
outputANSI?: boolean;
safeURLs?: boolean;
safeWords?: boolean;
}
```
- ```ts
interface StringSegmentDescriptor {
indexEnd: number;
indexStart: number;
type: StringSegmentType;
value: string;
}
```
- ```ts
type StringSegmentType =
| "ansi"
| "character"
| "emoji"
| "url"
| "word";
```
> [!NOTE]
> - For the full or prettier documentation, can visit via:
> - [Deno CLI `deno doc`](https://docs.deno.com/runtime/reference/cli/doc/)
> - [JSR](https://jsr.io/@hugoalh/string-dissect)
## ✍️ Examples
- ```ts
const sample1 = "Vel ex sit est sit est tempor enim et voluptua consetetur gubergren gubergren ut.";
Array.from(new StringDissector().dissect(sample1));
//=>
// [
// { value: "Vel", type: "word" },
// { value: " ", type: "character" },
// { value: "ex", type: "word" },
// { value: " ", type: "character" },
// { value: "sit", type: "word" },
// { value: " ", type: "character" },
// { value: "est", type: "word" },
// { value: " ", type: "character" },
// ... +20
// ]
Array.from(new StringDissector({ safeWords: false }).dissect(sample1));
//=>
// [
// { value: "V", type: "character" },
// { value: "e", type: "character" },
// { value: "l", type: "character" },
// { value: " ", type: "character" },
// { value: "e", type: "character" },
// { value: "x", type: "character" },
// { value: " ", type: "character" },
// { value: "s", type: "character" },
// ... +73
// ]
```
- ```ts
Array.from(new StringDissector().dissect("GitHub homepage is https://github.com."));
//=>
// [
// { value: "GitHub", type: "word" },
// { value: " ", type: "character" },
// { value: "homepage", type: "word" },
// { value: " ", type: "character" },
// { value: "is", type: "word" },
// { value: " ", type: "character" },
// { value: "https://github.com", type: "url" },
// { value: ".", type: "character" }
// ]
```
- ```ts
Array.from(new StringDissector().dissect("🤝💑💏👪👨👩👧👦👩👦👩👧👦🧑🤝🧑"), ({ value }) => {
return value;
});
//=> [ "🤝", "💑", "💏", "👪", "👨👩👧👦", "👩👦", "👩👧👦", "🧑🤝🧑" ]
```