split-symbol-object v1.0.0

split-symbol-object

At the symbols of any split the path string

Installation

npm install split-symbol-object

API

import toObject from 'split-symbol-object';

/**
 * @param  {string} value - target value.
 * @param  {string} separator - separator. e.g.'.'
 * @param  {string} firstKey - The first object key that was split in the separator.
 * @param  {object} symbols - separator and the object key.
 */
toObject(value, separator, firstKey, symbols)

Usage

For example split html tags

toObject("div#foo:class1:class2.span.p:bar", '.', 'tagName', { id: '#', className: ':' });
=> [ { tagName: 'div', id: 'foo', className: 'class1 class2' },
     { tagName: 'span' },
     { tagName: 'p', className: 'bar' } ]

For example split contacts

toObject("-Woody&5 -Buzz&3", ' ', '', { name: '-', age: '&' }));
=> [ { name: 'Woody', age: '5' }, { name: 'Buzz', age: '3' } ]

To ignore the first key

toObject("div#foo:class1:class2.span.p:bar", '.', null, { id: '#', className: ':' });
// ignored 'div' and 'span'
=> [ { id: 'foo', className: 'class1 class2' }, { className: 'bar' } ]

Like 'String.prototype.split()'

toObject("div#foo:cla1:cla2.span.p:bar", '.');
=> [ 'div#foo:cla1:cla2', 'span', 'p:bar' ]

Development

## build
npm run build

## test
npm test

License

MIT