fix: declare that of returns arrays of length 1

gcanti · Aug 10, 2023 · f934dc7 · f934dc7
1 parent 01b8661
commit f934dc7
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 6 deletions.
diff --git a/docs/modules/Array.ts.md b/docs/modules/Array.ts.md
@@ -238,7 +238,7 @@ element of the base type (this is useful for building a `Monad`).
 **Signature**
 
 ```ts
-export declare const of: <A>(a: A) => A[]
+export declare const of: <A>(a: A) => [A]
 ```
 
 **Example**

diff --git a/docs/modules/NonEmptyArray.ts.md b/docs/modules/NonEmptyArray.ts.md
@@ -176,7 +176,7 @@ Added in v2.11.0
 **Signature**
 
 ```ts
-export declare const of: <A>(a: A) => NonEmptyArray<A>
+export declare const of: <A>(a: A) => [A]
 ```
 
 Added in v2.0.0

diff --git a/dtslint/ts3.5/Array.ts b/dtslint/ts3.5/Array.ts
@@ -9,6 +9,8 @@ declare const ns: Array<number>
 declare const ss: Array<string>
 declare const tns: Array<[number, string]>
 
+pipe(_.of('b'), ([value]: [string]) => value)
+
 // prepend
 
 pipe(ss, _.prepend('a')) // $ExpectType NonEmptyArray<string>

diff --git a/package-lock.json b/package-lock.json
diff --git a/src/Array.ts b/src/Array.ts
@@ -1508,7 +1508,7 @@ const _chainRecBreadthFirst: ChainRec1<URI>['chainRec'] = RA._chainRecBreadthFir
  * @category constructors
  * @since 2.0.0
  */
-export const of: <A>(a: A) => Array<A> = NEA.of
+export const of: <A>(a: A) => [A] = NEA.of
 
 /**
  * Makes an empty `Array`, useful for building a [`Monoid`](#Monoid)

diff --git a/src/NonEmptyArray.ts b/src/NonEmptyArray.ts
@@ -464,7 +464,7 @@ export const copy: <A>(as: NonEmptyArray<A>) => NonEmptyArray<A> = fromReadonlyN
  * @category constructors
  * @since 2.0.0
  */
-export const of: <A>(a: A) => NonEmptyArray<A> = (a) => [a]
+export const of: <A>(a: A) => [A] = (a) => [a]
 
 /**
  * @since 2.5.1