Array.joinWith -> Array.join

Author: cknitt

scripts/DocTests.res

@@ -184,7 +184,7 @@ let testCode = async (~id, ~code) => {
   | true =>
     promise
     ->Array.map(e => e->Buffer.toString)
-    ->Array.joinWith("")
+    ->Array.join(~separator="")
     ->Error
   | false => Ok()
   }
@@ -259,7 +259,7 @@ let getCodeBlocks = example => {
             code
             ->List.reverse
             ->List.toArray
-            ->Array.joinWith("\n"),
+            ->Array.join(~separator="\n"),
             ...acc,
           },
         )
@@ -325,9 +325,9 @@ let main = async () => {
         e
         ->String.split("\n")
         ->Array.filterWithIndex((_, i) => i !== 2)
-        ->Array.joinWith("\n")
+        ->Array.join(~separator="\n")
       })
-      ->Array.joinWith("\n")
+      ->Array.join(~separator="\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>, ~separator: 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>, ~separator: 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,23 @@ 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`. If no separator is specified, `,` is used as the default. 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.
+
+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
+
+Console.log(array->Array.join(~separator=" -- ")) // One -- Two -- Three
+```
+*/
+@send
+external join: (array<string>, ~separator: 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 +424,27 @@ 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`. If no separator is specified, `,` is used as the default. 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
+
+Console.log(array->Array.joinUnsafe(~separator=" -- ")) // 1 -- 2 -- 3
+```
+*/
+@send
+external joinUnsafe: (array<'a>, ~separator: 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 +455,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"