README

Template literal - each

Tagged template literal to iterate over markdown style tables as objects.

Inspired by the Jest test.each syntax.

Installation

$ npm install --save template-literal-each

Exports

Being based on the template-literal-table package, as of v2.0 template-literal-each follows the same capabilities and flexibility

name	description
`default`	The default export, this is `each`
`each`	Table iterator, skips divider rows (cells only containing two or more `-` characters) and rows consisting of empty cells
`empty`	Table iterator, skips divider rows, preserves rows consisting of empty cells
`create`	Table iterator creator, creates a new iterator with custom row filter functions

API

`each` (`default`)

The each function is the recommended (and prior to v2.0 - the only) use, it iterates table structures as most like intended

import { each } from 'template-literal-each';

each`
    foo  | bar   | baz
    -----|-------|-----
    ${1} | ${2}  | ${4}
    ${2} | ${4}  | ${8}
    4    | 8     | 16
`((record) => {
    console.log(record);
});

//  { foo: 1, bar: 2, baz: 4},
//  { foo: 2, bar: 4, baz: 8},
//  { foo: '4', bar: '8', baz: '16'},

`empty`

Like the each function, with the difference that rows containing only undefined cells are preserved, do note that any newline in the table structure will become a record, regardless of intention. This means that a trailing newline (as shown below) will also result in a record (consisting of only undefined values).

import { empty } from('template-literal-each');

empty`
    foo  | bar   | baz
    -----|-------|-----
         |       |
    one
         | two
         |       | three
    ${1} | ${2}  | ${4}
    ${2} | ${4}  | ${8}
    4    | 8     | 16
`((record) => {
    console.log(record);
});

//  { foo: undefined, bar: undefined, baz: undefined},
//  { foo: 'one', bar: undefined, baz: undefined},
//  { foo: undefined, bar: 'two', baz: undefined},
//  { foo: undefined, bar: undefined, baz: 'three'},
//  { foo: 1, bar: 2, baz: 4},
//  { foo: 2, bar: 4, baz: 8},
//  { foo: '4', bar: '8', baz: '16'},
//  { foo: undefined, bar: undefined, baz: undefined},

`create`

The each and empty functions should cover most scenarios, though sometimes one needs different filter applied to the records passed in. For this purpose the create function exists, it allows any number of filters to be specified, which will be applied before the records are created from the values, meaning the filter function will receive all values as separate argument (no reference to the name, though the order represents the same order as the table columns)

The filter function signature is (...cells: unknown[]) => boolean, please refer to the underlying template-literal-table Filter tips for more information.

import { create } from 'template-literal-table';

// if the fourth column contains a value that is not a divider we want it to be present
const fourth = create((...values: unknown[]) => Boolean(values[3]) && !/^--+$/.test(String(values[3])) );
fourth`
    one | two | three | four
    ----|-----|-------|------
    1   | 2   | 3     | 4
    1   | 2   | 3     |
    1   | 2   |       | 4
    1   |     | 3     | 4
        | 2   | 3     | 4
`((record) => {
    console.log(record);
});

//  { one: '1', two: '2', three: '3', four: '4' },
//  { one: '1', two: '2', three: undefined, four: '4' },
//  { one: '1', two: undefined, three: '3', four: '4' },
//  { one: undefined, two: '2', three: '3', four: '4' },

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!