join

Return a string created by joining array elements using a specified separator.

Usage

var join = require( '@stdlib/array/base/join' );

join( x, separator )

Returns a string created by joining array elements using a specified separator.

var x = [ 1, 2, 3, 4, 5, 6 ];

var out = join( x, ',' );
// returns '1,2,3,4,5,6'

Notes

If provided an array-like object having a join method, the function defers execution to that method and assumes that the method API has the following signature:
```
x.join( separator )
```
If provided an array-like object without a join method, the function manually constructs the output string.
If an array element is either null or undefined, the function will serialize the element as an empty string.

Examples

var Complex128Array = require( '@stdlib/array/complex128' );
var Complex64Array = require( '@stdlib/array/complex64' );
var AccessorArray = require( '@stdlib/array/base/accessor' );
var Float64Array = require( '@stdlib/array/float64' );
var join = require( '@stdlib/array/base/join' );

var x = [ 0, 1, 2, 3, 4, 5 ];
var s = join( x, ',' );
// returns '0,1,2,3,4,5'

x = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ] );
s = join( x, ',' );
// returns '0,1,2,3,4,5'

s = join( x, '-' );
// returns '0-1-2-3-4-5'

x = new AccessorArray( [ 1, 2, 3, 4 ] );
s = join( x, ',' );
// returns '1,2,3,4'

x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
s = join( x, ',' );
// returns '1 + 2i,3 + 4i,5 + 6i'

x = new Complex64Array( [ 1.0, -1.0, 2.0, -2.0 ] );
s = join( x, ',' );
// returns '1 - 1i,2 - 2i'