Skip to main content
Deno 2 is finally here 🎉️
Learn more
Go to Latest
The Standard Library has been moved to JSR. See the blog post for details.
function joinToString
import { joinToString } from "https://deno.land/std@0.147.0/collections/join_to_string.ts";

Transforms the elements in the given array to strings using the given selector. Joins the produced strings into one using the given separator and applying the given prefix and suffix to the whole string afterwards. If the array could be huge, you can specify a non-negative value of limit, in which case only the first limit elements will be appended, followed by the truncated string. Returns the resulting string.

Example:

import { joinToString } from "https://deno.land/std@0.147.0/collections/join_to_string.ts";
import { assertEquals } from "https://deno.land/std@0.147.0/testing/asserts.ts";

const users = [
  { name: "Kim" },
  { name: "Anna" },
  { name: "Tim" },
];

 const message = joinToString(users, (it) => it.name, {
  suffix: " are winners",
  prefix: "result: ",
  separator: " and ",
  limit: 1,
  truncated: "others",
});

assertEquals(message, "result: Kim and others are winners");

Parameters

array: readonly T[]
selector: (el: T) => string
optional
unnamed 2: Readonly<JoinToStringOptions> = [UNSUPPORTED]

Returns

string