join

INFO

This function is only available in es-toolkit/compat for compatibility reasons. It either has alternative native JavaScript APIs or isn’t fully optimized yet.

When imported from es-toolkit/compat, it behaves exactly like lodash and provides the same functionalities, as detailed here.

Joins elements of an array into a string.

Signature

function join<T>(array: T[], separator?: string): string;

Parameters

• array (T[]) - The array to join.

array can be ArrayLike<T> or null or undefined

To ensure full compatibility with lodash, the join function processes array as follows:

• If array is ArrayLike<T>, it converts it to an array using Array.from(...).
• If array is null or undefined, it is treated as an empty array.

• separator (string) - The separator used to join the elements. Defaults to ,.

Returns

(string): A string containing all elements of the array joined by the specified separator.

Examples

const arr = ['a', 'b', 'c'];
const result = join(arr, '~');
console.log(result); // Output: "a~b~c"