string-array

String Array

• API reference - TypeDoc
• Markdown reference - the full API and runtime behavior in one file. Also ships in the package.
• GitHub

Parse string into array of string elements.

"[ hello, world, [ 1, [2, [ 3 ]]]]" ➡️ [ "hello", "world", [ "1", [ "2", [ "3" ]]]]

Install

npm i --save string-array

Usage

const stringArray = require("string-array");

const r1 = stringArray.parse("[]");
// r1 === { prefix: "", array: [], remain: "" }
const r2 = stringArray.parse("test[1,2,3]");
// r2 === { prefix: "test", array: ["1","2","3"], remain: "" }

• Elements are automatically treated as strings, so quotes ', " and backtick are taken as part of element.

• All leading and trailing whitespaces are automatically trimed.

• Can't have , or ] in elements. A [ in the middle of an element is kept as plain text, but the next ] still closes the array, so [a[b], c] gives ["a[b"] with c] left in remain.

Examples

• stringArray.parse(""):
• stringArray.parse("[]"):

{
  prefix: "",
  array: [],
  remain: ""
}

• stringArray.parse('test[1,2,"3"]'):

{
  prefix: "test",
  array: ["1","2", '"3"'],
  remain: ""
}

• stringArray.parse("[hello, world, [ [ foo, bar ], 1, [ 2 ], 3 ] ] some other stuff [blah]"):

{
  prefix: "",
  array: ["hello", "world", [ ["foo", "bar"], "1", ["2"], "3" ] ],
  remain: "some other stuff [blah]"
}

More samples in test

Parameters

stringArray.parse(str, noPrefix, noExtra)

• str - string array to be parsed
• noPrefix - if true, then do not check for a prefix
• noExtra - if true, then do not allow trailing text following a complete array in str

Throws

• AssertionError("array missing [")
  • Also throws if str doesn't start with [ and noPrefix is true
• AssertionError("array missing ]")
• AssertionError("array has extra ]")
• AssertionError("extra data at end of array") - if noExtra is true and there are extra text following a complete array in str

License

Licensed under the Apache License, Version 2.0