Add Array.tuple (Effect-TS#301)

KhraksMamtsov · Mar 31, 2023 · 440ea09 · 440ea09
1 parent 545287e
commit 440ea09
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 0 deletions.
diff --git a/.changeset/hot-toys-walk.md b/.changeset/hot-toys-walk.md
@@ -0,0 +1,5 @@
+---
+"@effect/data": patch
+---
+
+Add Array.tuple
diff --git a/docs/modules/ReadonlyArray.ts.md b/docs/modules/ReadonlyArray.ts.md
@@ -130,6 +130,7 @@ Added in v1.0.0
   - [flap](#flap)
   - [map](#map)
   - [mapNonEmpty](#mapnonempty)
+  - [tuple](#tuple)
   - [tupled](#tupled)
 - [models](#models)
   - [NonEmptyArray (type alias)](#nonemptyarray-type-alias)
@@ -1638,6 +1639,16 @@ export declare const mapNonEmpty: {
 
 Added in v1.0.0
 
+## tuple
+
+**Signature**
+
+```ts
+export declare const tuple: <Args extends any[]>(...args: Args) => Args
+```
+
+Added in v1.0.0
+
 ## tupled
 
 **Signature**

diff --git a/src/ReadonlyArray.ts b/src/ReadonlyArray.ts
@@ -1500,6 +1500,12 @@ export const Invariant: invariant.Invariant<ReadonlyArrayTypeLambda> = {
 export const tupled: <A>(self: ReadonlyArray<A>) => Array<[A]> = invariant
   .tupled(Invariant) as any
 
+/**
+ * @category mapping
+ * @since 1.0.0
+ */
+export const tuple: <Args extends Array<any>>(...args: Args) => Args = (...args) => args
+
 /**
  * @category mapping
  * @since 1.0.0

diff --git a/test/ReadonlyArray.ts b/test/ReadonlyArray.ts
@@ -1454,6 +1454,10 @@ describe.concurrent("ReadonlyArray", () => {
     deepStrictEqual(S.combine([1, 2], [1, 2]), [1, 2])
   })
 
+  it("tuple", () => {
+    deepStrictEqual(RA.tuple(0, 1, 2), [0, 1, 2])
+  })
+
   it("empty", () => {
     deepStrictEqual(RA.empty.length, 0)
   })