stringweaver

> [!IMPORTANT]
> This repository is moved to Codeberg.org.
>
> For now it is kept in sync with the original repository @Github.
>
> Depending on future USA/Microsoft/Github policies the Github version maybe discontinued later.
>
> In other words, starting july 10 2025 the Codeberg repository is authorative**.

js-stringweaver

An ES/JS "stringbuilder" utility module. The module delivers a constructor to create mutable strings.

$3

- [x] small footprint
- [x] extendable with custom getters/methods
- [x] retains history of changes
- [x] no external dependencies
- [x] instances can use and/or chain native String getters/methods (e.g. replace, split, length)
- [x] 100% test coverage

$3

Demonstration / Documentation.
Idem @Github

$3

Use npm install stringweaver to install the module locally.

$3

``javascript
/* notes:
- make sure the script/node project is of type "module"
- the bundled module can be found @ https://unpkg.com/stringweaver/Bundle/index.min.js
- the module is imported as $S here */
import $S from "[location of index.js or Bundle/index.min.js]";

// assign the symbolic string extension
const SB = Symbol.toSB;
const myBrandNewString = $SHello.append(" world");
const myNextString = "** "[SB].append(myBrandNewString).toUpperCase().append(!);
// myBrandNewString => "Hello world"
// myNextString => "** HELLO WORLD!"
`

$3

Use npm test` to run all tests (with coverage report)