README
string-find-heads-tails
Finds where are arbitrary templating marker heads and tails located
Install
The latest version is ESM only: Node 12+ is needed to use it and it must be import
ed instead of require
d. If your project is not on ESM yet and you want to use require
, use an older version of this program, 4.1.0
.
npm i string-find-heads-tails
Quick Take
import { strict as assert } from "assert";
import { strFindHeadsTails } from "string-find-heads-tails";
// processing an arbitrary, custom templating markup:
assert.deepEqual(
strFindHeadsTails(
"some text %%_var1-%% more text %%_var2_%%",
["%%_", "%%-"], // two flavours of heads
["-%%", "_%%"] // two flavours of tails
),
[
{
headsStartAt: 10,
headsEndAt: 13,
tailsStartAt: 17,
tailsEndAt: 20,
},
{
headsStartAt: 31,
headsEndAt: 34,
tailsStartAt: 38,
tailsEndAt: 41,
},
]
);
Documentation
Please visit codsen.com for a full description of the API.
Contributing
To report bugs or request features or assistance, raise an issue on GitHub.
Licence
MIT License
Copyright (c) 2010-2022 Roy Revelt and other contributors