split-split

Split string and keep separators.

Installation

npm

npm install split-split

Usage

ESM:

import { split, join } from "split-split";
const [substrings, separators] = split("split split\tsplit|split", [
  " ",
  "\t",
  "|",
]);
console.log(substrings, separators); // => ["split", "split", "split", "split"] [" ", "\t", "|"]

const str = join(substrings, separators);
console.log(str); // => "split split\tsplit|split"

CJS:

const { split, join } = require("split-split");
const [substrings, separators] = split("split split\tsplit|split", [
  " ",
  "\t",
  "|",
]);
console.log(substrings, separators); // => ["split", "split", "split", "split"] [" ", "\t", "|"]

const str = join(substrings, separators);
console.log(str); // => "split split\tsplit|split"

CDN:

<script src="https://cdn.jsdelivr.net/npm/split-split"></script>
<script>
  const { split, join } = splitSplit;

  const [substrings, separators] = split("split split\tsplit|split", [
    " ",
    "\t",
    "|",
  ]);
  console.log(substrings, separators); // => ["split", "split", "split", "split"] [" ", "\t", "|"]

  const str = join(substrings, separators);
  console.log(str); // => "split split\tsplit|split"
</script>

API

split(string, separator)

The split() method divides the given string into an ordered list of substring, puts these substrings into an array, and returns the substrings array and separators array. The division is done by searching for a pattern; where the pattern is provided as the second parameter in the method's call.

Example

const [substrings1, separators1] = split("split split\tsplit|split", [
  " ",
  "\t",
  "|",
]);
console.log(substrings1, separators1); // => ["split", "split", "split", "split"] [" ", "\t", "|"]

const [substrings2, separators2] = split("split split\tsplit|split", /[ \t|]/g);
console.log(substrings2, separators2); // => ["split", "split", "split", "split"] [" ", "\t", "|"]

Parameters

• string (string) — String being split.
• separator (Array<string> | RegExp) - Separator to divide the given string.

Returns

An array, the first item is an array of substrings, the second item is an array of separators.

join(substrings, separators)

The join() method creates and returns a new string by concatenating all of the elements in substrings, separated by separators.

Example

const string = join(["split", "split", "split", "split"], [" ", "\t", "|"]);
console.log(string); // => "split split\tsplit|split"

Parameters

• strings (Array<string>) — Substrings being join.
• separators (Array<string>) - Separators being join.

Returns

A string consisting of the separators inserted into the substrings.

Release Notes

[TODO]

[Unreleased]

v0.0.2

• Fix typescript exports.

v0.0.1

• Added features split and join.