Array.joinWith -> Array.join

Author: cknitt

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Next version
 
+- Add `Array.join` and deprecate `Array.joinWith`. https://github.com/rescript-association/rescript-core/pull/205
 - BREAKING: Intl types: simplify bindings for constructors / functions with optional arguments. https://github.com/rescript-association/rescript-core/pull/198
 - Fix: Expose Intl.Common. https://github.com/rescript-association/rescript-core/pull/197
 - Add `Array.flatMapWithIndex` https://github.com/rescript-association/rescript-core/pull/199

scripts/DocTests.mjs

@@ -143,7 +143,7 @@ async function testCode(id, code) {
     "-I",
     rescriptCoreCompiled,
     "-w",
-    "-109",
+    "-3-109",
     "-uncurried",
     "-open",
     "RescriptCore"

scripts/DocTests.res

@@ -163,7 +163,7 @@ let testCode = async (~id, ~code) => {
     "-I",
     rescriptCoreCompiled,
     "-w",
-    "-109",
+    "-3-109",
     "-uncurried",
     "-open",
     "RescriptCore",
@@ -184,7 +184,7 @@ let testCode = async (~id, ~code) => {
   | true =>
     promise
     ->Array.map(e => e->Buffer.toString)
-    ->Array.joinWith("")
+    ->Array.join("")
     ->Error
   | false => Ok()
   }
@@ -259,7 +259,7 @@ let getCodeBlocks = example => {
             code
             ->List.reverse
             ->List.toArray
-            ->Array.joinWith("\n"),
+            ->Array.join("\n"),
             ...acc,
           },
         )
@@ -325,9 +325,9 @@ let main = async () => {
         e
         ->String.split("\n")
         ->Array.filterWithIndex((_, i) => i !== 2)
-        ->Array.joinWith("\n")
+        ->Array.join("\n")
       })
-      ->Array.joinWith("\n")
+      ->Array.join("\n")
 
     let message = `${"error"->red}: failed to compile examples from ${kind} ${test.id->cyan}\n${errorMessage}`
 

src/Core__Array.res

@@ -124,9 +124,15 @@ let indexOfOpt = (arr, item) =>
   }
 @send external indexOfFrom: (array<'a>, 'a, int) => int = "indexOf"
 
-@send external joinWith: (array<string>, string) => string = "join"
+@send external join: (array<string>, string) => string = "join"
 
-@send external joinWithUnsafe: (array<'a>, string) => string = "join"
+@deprecated("Use `join` instead") @send
+external joinWith: (array<string>, string) => string = "join"
+
+@send external joinUnsafe: (array<'a>, string) => string = "join"
+
+@deprecated("Use `joinUnsafe` instead") @send
+external joinWithUnsafe: (array<'a>, string) => string = "join"
 
 @send external lastIndexOf: (array<'a>, 'a) => int = "lastIndexOf"
 let lastIndexOfOpt = (arr, item) =>

src/Core__Array.resi

@@ -397,6 +397,21 @@ Console.log([{"language": "ReScript"}]->Array.indexOfOpt({"language": "ReScript"
 let indexOfOpt: (array<'a>, 'a) => option<int>
 @send external indexOfFrom: (array<'a>, 'a, int) => int = "indexOf"
 
+/**
+`join(array, separator)` produces a string where all items of `array` are printed, separated by `separator`. Array items must be strings, to join number or other arrays, use `joinUnsafe`. Under the hood this will run JavaScript's `toString` on all the array items.
+
+See [Array.join](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join)
+
+## Examples
+```rescript
+let array = ["One", "Two", "Three"]
+
+Console.log(array->Array.join(" -- ")) // One -- Two -- Three
+```
+*/
+@send
+external join: (array<string>, string) => string = "join"
+
 /**
 `joinWith(array, separator)` produces a string where all items of `array` are printed, separated by `separator`. Array items must be strings, to join number or other arrays, use `joinWithUnsafe`. Under the hood this will run JavaScript's `toString` on all the array items.
 
@@ -407,9 +422,25 @@ let array = ["One", "Two", "Three"]
 Console.log(array->Array.joinWith(" -- ")) // One -- Two -- Three
 ```
 */
+@deprecated("Use `join` instead")
 @send
 external joinWith: (array<string>, string) => string = "join"
 
+/**
+`joinUnsafe(array, separator)` produces a string where all items of `array` are printed, separated by `separator`. Under the hood this will run JavaScript's `toString` on all the array items.
+
+See [Array.join](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join)
+
+## Examples
+```rescript
+let array = [1, 2, 3]
+
+Console.log(array->Array.joinUnsafe(" -- ")) // 1 -- 2 -- 3
+```
+*/
+@send
+external joinUnsafe: (array<'a>, string) => string = "join"
+
 /**
 `joinWithUnsafe(array, separator)` produces a string where all items of `array` are printed, separated by `separator`. Under the hood this will run JavaScript's `toString` on all the array items.
 
@@ -420,6 +451,7 @@ let array = [1, 2, 3]
 Console.log(array->Array.joinWithUnsafe(" -- ")) // 1 -- 2 -- 3
 ```
 */
+@deprecated("Use `joinUnsafe` instead")
 @send
 external joinWithUnsafe: (array<'a>, string) => string = "join"
 @send external lastIndexOf: (array<'a>, 'a) => int = "lastIndexOf"