Skip to main content

Function: joinAsync()

Returns a promise that resolves to the result of concatenating the values of asyncIterable to a string where values are separated by separator.

Like Array.prototype.join, but for async iterables, but does not treat null, undefined, or [] specially.

Example​

console.log(
  await pipe(
    asAsync([`sloth`, `more sloth`, `even more sloth`]),
    joinAsync(`, `),
  ),
)
//=> sloth, more sloth, even more sloth

joinAsync(separator)​

joinAsync(separator): (asyncIterable) => Promise<string>

Returns a promise that resolves to the result of concatenating the values of asyncIterable to a string where values are separated by separator.

Like Array.prototype.join, but for async iterables, but does not treat null, undefined, or [] specially.

Parameters​

• separator: string

Returns​

Function

Parameters​

• asyncIterable: AsyncIterable<unknown, any, any>

Returns​

Promise<string>

Example​

console.log(
  await pipe(
    asAsync([`sloth`, `more sloth`, `even more sloth`]),
    joinAsync(`, `),
  ),
)
//=> sloth, more sloth, even more sloth

Defined in​

collections.d.ts:422

joinAsync(separator, asyncIterable)​

joinAsync(separator, asyncIterable): Promise<string>

Returns a promise that resolves to the result of concatenating the values of asyncIterable to a string where values are separated by separator.

Like Array.prototype.join, but for async iterables, but does not treat null, undefined, or [] specially.

Parameters​

• separator: string

• asyncIterable: AsyncIterable<unknown, any, any>

Returns​

Promise<string>

Example​

console.log(
  await pipe(
    asAsync([`sloth`, `more sloth`, `even more sloth`]),
    joinAsync(`, `),
  ),
)
//=> sloth, more sloth, even more sloth

Defined in​

collections.d.ts:425