@hugoalh/string-dissect v3.0.0

String Dissect (ES)

⚖️ MIT

An ES (JavaScript & TypeScript) module to dissect the string; Safe with the emojis, URLs, and words.

🎯 Target

• Bun ^ v1.0.0
• Cloudflare Workers
• Deno >= v1.34.0 / >= v1.41.1 (For JSR Only)

  🛡️ Require Permission

  N/A

• NodeJS >= v20.9.0

🔰 Usage

Via JSR With node_modules

🎯 Supported Target

• Bun
• Cloudflare Workers
• NodeJS

1. Install via:
   • Bun

     bunx jsr add @hugoalh/string-dissect[@${Tag}]

   • NPM

     npx jsr add @hugoalh/string-dissect[@${Tag}]

   • PNPM

     pnpm dlx jsr add @hugoalh/string-dissect[@${Tag}]

   • Yarn

     yarn dlx jsr add @hugoalh/string-dissect[@${Tag}]

2. Import at the script:

   import ... from "@hugoalh/string-dissect";

ℹ️ 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 property exports for available sub paths.
• It is recommended to import the module with tag for immutability.

Via JSR With Specifier

🎯 Supported Target

• Deno

1. Import at the script:

   import ... from "jsr:@hugoalh/string-dissect[@${Tag}]";

ℹ️ 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 property exports for available sub paths.
• It is recommended to import the module with tag for immutability.

Via NPM With node_modules

🎯 Supported Target

• Cloudflare Workers
• NodeJS

1. Install via:
   • NPM

     npm install @hugoalh/string-dissect[@${Tag}]

   • PNPM

     pnpm add @hugoalh/string-dissect[@${Tag}]

   • Yarn

     yarn add @hugoalh/string-dissect[@${Tag}]

2. Import at the script:

   import ... from "@hugoalh/string-dissect";

ℹ️ 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 property exports for available sub paths.
• It is recommended to import the module with tag for immutability.

Via NPM With Specifier

🎯 Supported Target

• Bun
• Deno

1. Import at the script:

   import ... from "npm:@hugoalh/string-dissect[@${Tag}]";

ℹ️ 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 property exports for available sub paths.
• It is recommended to import the module with tag for immutability.

Via Remote Import

🎯 Supported Target

• Deno

1. Import at the script:

   /* Via GitHub Raw (Require Tag) */
   import ... from "https://raw.githubusercontent.com/hugoalh-studio/string-dissect-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.

🧩 API

• class StringDissector {
    constructor(options: StringDissectorOptions = {}): StringDissector;
    dissect(item: string, optionsOverride: StringDissectorOptions = {}): Generator<StringSegmentDescriptor>;
    dissectExtend(item: string, optionsOverride: StringDissectorOptions = {}): Generator<StringSegmentDescriptorExtend>;
    static dissect(item: string, options: StringDissectorOptions = {}): Generator<StringSegmentDescriptor>;
    static dissectExtend(item: string, options: StringDissectorOptions = {}): Generator<StringSegmentDescriptorExtend>;
  }

• function dissectString(item: string, options: StringDissectorOptions = {}): Generator<StringSegmentDescriptor>;

• function dissectStringExtend(item: string, options: StringDissectorOptions = {}): Generator<StringSegmentDescriptorExtend>;

• enum StringSegmentType {
    ansi = "ansi",
    ANSI = "ansi",
    character = "character",
    Character = "character",
    emoji = "emoji",
    Emoji = "emoji",
    url = "url",
    Url = "url",
    URL = "url",
    word = "word",
    Word = "word"
  }

• interface StringDissectorOptions {
    /**
     * The locale(s) to use in the operation; The JavaScript implementation examines locales, and then computes a locale it understands that comes closest to satisfying the expressed preference. By default, the implementation's default locale will be used. For more information, please visit https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument.
     * @default undefined
     */
    locales?: StringDissectorLocales;
    /**
     * Whether to remove ANSI escape codes.
     * @default false
     */
    removeANSI?: boolean;
    /**
     * Whether to prevent URLs get splitted.
     * @default true
     */
    safeURLs?: boolean;
    /**
     * Whether to prevent words get splitted.
     * @default true
     */
    safeWords?: boolean;
  }

• interface StringSegmentDescriptor {
    type: StringSegmentType;
    value: string;
  }

• interface StringSegmentDescriptorExtend extends StringSegmentDescriptor {
    indexEnd: number;
    indexStart: number;
  }

• type StringDissectorLocales = ConstructorParameters<typeof Intl.Segmenter>[0];

ℹ️ Note

For the prettier documentation, can visit via:

• Deno CLI deno doc
• JSR

✍️ Example

• const sample1 = "Vel ex sit est sit est tempor enim et voluptua consetetur gubergren gubergren ut.";
  
  /* Either */
  Array.from(new StringDissector().dissect(sample1));
  Array.from(dissectString(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
  ]
  */
  
  /* Either */
  Array.from(new StringDissector({ safeWords: false }).dissect(sample1));
  Array.from(dissectString(sample1, { safeWords: false }));
  /*=>
  [
    { 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
  ]
  */

• /* Either */
  Array.from(new StringDissector().dissect("GitHub homepage is https://github.com."));
  Array.from(dissectString("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" }
  ]
  */

• /* Either */
  Array.from(new StringDissector().dissect("🤝💑💏👪👨‍👩‍👧‍👦👩‍👦👩‍👧‍👦🧑‍🤝‍🧑")).map((element) => { return element.value; });
  Array.from(dissectString("🤝💑💏👪👨‍👩‍👧‍👦👩‍👦👩‍👧‍👦🧑‍🤝‍🧑")).map((element) => { return element.value; });
  //=> [ "🤝", "💑", "💏", "👪", "👨‍👩‍👧‍👦", "👩‍👦", "👩‍👧‍👦", "🧑‍🤝‍🧑" ]