README.md

SplitSymbol

Split symbol which is used to define a custom string splitting behavior.

Usage

var SplitSymbol = require( '@stdlib/symbol/split' );

SplitSymbol

Split symbol which is used to define a custom string splitting behavior.

var s = typeof SplitSymbol;
// e.g., returns 'symbol'

Examples

var SplitSymbol = require( '@stdlib/symbol/split' );

var str;
var obj;
var parts;

function splitHandler() {
    return [ 'beep', 'boop' ];
}

if ( SplitSymbol ) {
    str = 'beep-boop';
    obj = {};
    obj[ SplitSymbol ] = splitHandler;
    parts = str.split( obj );
    console.log( parts );
    // => [ 'beep', 'boop' ]
}