revert 0.0.10 changes

fp-ts · Dec 14, 2022 · c27db5e · c27db5e
1 parent 1fc7493
commit c27db5e
Show file tree

Hide file tree

Showing 68 changed files with 374 additions and 341 deletions.
diff --git a/.changeset/loud-paws-chew.md b/.changeset/loud-paws-chew.md
@@ -0,0 +1,5 @@
+---
+"@fp-ts/core": patch
+---
+
+revert 0.0.10 changes
diff --git a/docs/modules/HKT.ts.md b/docs/modules/HKT.ts.md
@@ -27,20 +27,20 @@ Added in v1.0.0
 
 ```ts
 export type Kind<F extends TypeLambda, In, Out2, Out1, Target> = F extends {
-  type: unknown
+  readonly type: unknown
 }
   ? (F & {
-      In: In
-      Out2: Out2
-      Out1: Out1
-      Target: Target
+      readonly In: In
+      readonly Out2: Out2
+      readonly Out1: Out1
+      readonly Target: Target
     })['type']
   : {
-      F: F
-      In: (_: In) => void
-      Out2: () => Out2
-      Out1: () => Out1
-      Target: (_: Target) => Target
+      readonly F: F
+      readonly In: (_: In) => void
+      readonly Out2: () => Out2
+      readonly Out1: () => Out1
+      readonly Target: (_: Target) => Target
     }
 ```
 
@@ -52,7 +52,7 @@ Added in v1.0.0
 
 ```ts
 export interface TypeClass<F extends TypeLambda> {
-  [URI]?: F
+  readonly [URI]?: F
 }
 ```
 
@@ -64,10 +64,10 @@ Added in v1.0.0
 
 ```ts
 export interface TypeLambda {
-  In: unknown
-  Out2: unknown
-  Out1: unknown
-  Target: unknown
+  readonly In: unknown
+  readonly Out2: unknown
+  readonly Out1: unknown
+  readonly Target: unknown
 }
 ```
 

diff --git a/docs/modules/typeclass/Bicovariant.ts.md b/docs/modules/typeclass/Bicovariant.ts.md
@@ -29,7 +29,10 @@ Added in v1.0.0
 
 ```ts
 export interface Bicovariant<F extends TypeLambda> extends TypeClass<F> {
-  bimap: <E1, E2, A, B>(f: (e: E1) => E2, g: (a: A) => B) => <R, O>(self: Kind<F, R, O, E1, A>) => Kind<F, R, O, E2, B>
+  readonly bimap: <E1, E2, A, B>(
+    f: (e: E1) => E2,
+    g: (a: A) => B
+  ) => <R, O>(self: Kind<F, R, O, E1, A>) => Kind<F, R, O, E2, B>
 }
 ```
 

diff --git a/docs/modules/typeclass/Bounded.ts.md b/docs/modules/typeclass/Bounded.ts.md
@@ -30,8 +30,8 @@ Added in v1.0.0
 
 ```ts
 export interface Bounded<A> extends Order<A> {
-  maxBound: A
-  minBound: A
+  readonly maxBound: A
+  readonly minBound: A
 }
 ```
 
@@ -45,7 +45,7 @@ Added in v1.0.0
 
 ```ts
 export interface BoundedTypeLambda extends TypeLambda {
-  type: Bounded<this['Target']>
+  readonly type: Bounded<this['Target']>
 }
 ```
 

diff --git a/docs/modules/typeclass/Chainable.ts.md b/docs/modules/typeclass/Chainable.ts.md
@@ -67,7 +67,7 @@ export declare const bind: <F extends TypeLambda>(
   f: (a: A) => Kind<F, R2, O2, E2, B>
 ) => <R1, O1, E1>(
   self: Kind<F, R1, O1, E1, A>
-) => Kind<F, R1 & R2, O2 | O1, E2 | E1, { [K in N | keyof A]: K extends keyof A ? A[K] : B }>
+) => Kind<F, R1 & R2, O2 | O1, E2 | E1, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>
 ```
 
 Added in v1.0.0

diff --git a/docs/modules/typeclass/Contravariant.ts.md b/docs/modules/typeclass/Contravariant.ts.md
@@ -44,7 +44,7 @@ Added in v1.0.0
 
 ```ts
 export interface Contravariant<F extends TypeLambda> extends Invariant<F> {
-  contramap: <B, A>(f: (b: B) => A) => <R, O, E>(self: Kind<F, R, O, E, A>) => Kind<F, R, O, E, B>
+  readonly contramap: <B, A>(f: (b: B) => A) => <R, O, E>(self: Kind<F, R, O, E, A>) => Kind<F, R, O, E, B>
 }
 ```
 

diff --git a/docs/modules/typeclass/Coproduct.ts.md b/docs/modules/typeclass/Coproduct.ts.md
@@ -27,9 +27,9 @@ Added in v1.0.0
 
 ```ts
 export interface Coproduct<F extends TypeLambda> extends SemiCoproduct<F> {
-  zero: <A>() => Kind<F, unknown, never, never, A>
+  readonly zero: <A>() => Kind<F, unknown, never, never, A>
 
-  coproductAll: <R, O, E, A>(collection: Iterable<Kind<F, R, O, E, A>>) => Kind<F, R, O, E, A>
+  readonly coproductAll: <R, O, E, A>(collection: Iterable<Kind<F, R, O, E, A>>) => Kind<F, R, O, E, A>
 }
 ```
 

diff --git a/docs/modules/typeclass/Covariant.ts.md b/docs/modules/typeclass/Covariant.ts.md
@@ -87,7 +87,7 @@ Added in v1.0.0
 
 ```ts
 export interface Covariant<F extends TypeLambda> extends Invariant<F> {
-  map: <A, B>(f: (a: A) => B) => <R, O, E>(self: Kind<F, R, O, E, A>) => Kind<F, R, O, E, B>
+  readonly map: <A, B>(f: (a: A) => B) => <R, O, E>(self: Kind<F, R, O, E, A>) => Kind<F, R, O, E, B>
 }
 ```
 

diff --git a/docs/modules/typeclass/FlatMap.ts.md b/docs/modules/typeclass/FlatMap.ts.md
@@ -29,7 +29,7 @@ Added in v1.0.0
 
 ```ts
 export interface FlatMap<F extends TypeLambda> extends TypeClass<F> {
-  flatMap: <A, R2, O2, E2, B>(
+  readonly flatMap: <A, R2, O2, E2, B>(
     f: (a: A) => Kind<F, R2, O2, E2, B>
   ) => <R1, O1, E1>(self: Kind<F, R1, O1, E1, A>) => Kind<F, R1 & R2, O1 | O2, E1 | E2, B>
 }

diff --git a/docs/modules/typeclass/Foldable.ts.md b/docs/modules/typeclass/Foldable.ts.md
@@ -34,7 +34,7 @@ Added in v1.0.0
 
 ```ts
 export interface Foldable<F extends TypeLambda> extends TypeClass<F> {
-  reduce: <A, B>(b: B, f: (b: B, a: A) => B) => <R, O, E>(self: Kind<F, R, O, E, A>) => B
+  readonly reduce: <A, B>(b: B, f: (b: B, a: A) => B) => <R, O, E>(self: Kind<F, R, O, E, A>) => B
 }
 ```
 

diff --git a/docs/modules/typeclass/Invariant.ts.md b/docs/modules/typeclass/Invariant.ts.md
@@ -29,7 +29,10 @@ Added in v1.0.0
 
 ```ts
 export interface Invariant<F extends TypeLambda> extends TypeClass<F> {
-  imap: <A, B>(to: (a: A) => B, from: (b: B) => A) => <R, O, E>(self: Kind<F, R, O, E, A>) => Kind<F, R, O, E, B>
+  readonly imap: <A, B>(
+    to: (a: A) => B,
+    from: (b: B) => A
+  ) => <R, O, E>(self: Kind<F, R, O, E, A>) => Kind<F, R, O, E, B>
 }
 ```
 
@@ -44,7 +47,9 @@ Added in v1.0.0
 ```ts
 export declare const bindTo: <F extends TypeLambda>(
   F: Invariant<F>
-) => <N extends string>(name: N) => <R, O, E, A>(self: Kind<F, R, O, E, A>) => Kind<F, R, O, E, { [K in N]: A }>
+) => <N extends string>(
+  name: N
+) => <R, O, E, A>(self: Kind<F, R, O, E, A>) => Kind<F, R, O, E, { readonly [K in N]: A }>
 ```
 
 Added in v1.0.0
@@ -76,7 +81,7 @@ Added in v1.0.0
 ```ts
 export declare const tupled: <F extends TypeLambda>(
   F: Invariant<F>
-) => <R, O, E, A>(self: Kind<F, R, O, E, A>) => Kind<F, R, O, E, [A]>
+) => <R, O, E, A>(self: Kind<F, R, O, E, A>) => Kind<F, R, O, E, readonly [A]>
 ```
 
 Added in v1.0.0
diff --git a/docs/modules/typeclass/Monoid.ts.md b/docs/modules/typeclass/Monoid.ts.md
@@ -75,8 +75,8 @@ Added in v1.0.0
 
 ```ts
 export interface Monoid<A> extends Semigroup<A> {
-  empty: A
-  combineAll: (collection: Iterable<A>) => A
+  readonly empty: A
+  readonly combineAll: (collection: Iterable<A>) => A
 }
 ```
 
@@ -103,7 +103,9 @@ Given a struct of monoids returns a monoid for the struct.
 **Signature**
 
 ```ts
-export declare const struct: <A>(monoids: { [K in keyof A]: Monoid<A[K]> }) => Monoid<{ [K in keyof A]: A[K] }>
+export declare const struct: <A>(monoids: { readonly [K in keyof A]: Monoid<A[K]> }) => Monoid<{
+  readonly [K in keyof A]: A[K]
+}>
 ```
 
 Added in v1.0.0
@@ -115,7 +117,9 @@ Given a tuple of monoids returns a monoid for the tuple.
 **Signature**
 
 ```ts
-export declare const tuple: <A extends any[]>(...monoids: { [K in keyof A]: Monoid<A[K]> }) => Monoid<A>
+export declare const tuple: <A extends readonly any[]>(
+  ...monoids: { [K in keyof A]: Monoid<A[K]> }
+) => Monoid<Readonly<A>>
 ```
 
 Added in v1.0.0
diff --git a/docs/modules/typeclass/NonEmptyTraversable.ts.md b/docs/modules/typeclass/NonEmptyTraversable.ts.md
@@ -31,13 +31,13 @@ Added in v1.0.0
 
 ```ts
 export interface NonEmptyTraversable<T extends TypeLambda> extends TypeClass<T> {
-  traverseNonEmpty: <F extends TypeLambda>(
+  readonly traverseNonEmpty: <F extends TypeLambda>(
     F: SemiApplicative<F>
   ) => <A, R, O, E, B>(
     f: (a: A) => Kind<F, R, O, E, B>
   ) => <TR, TO, TE>(self: Kind<T, TR, TO, TE, A>) => Kind<F, R, O, E, Kind<T, TR, TO, TE, B>>
 
-  sequenceNonEmpty: <F extends TypeLambda>(
+  readonly sequenceNonEmpty: <F extends TypeLambda>(
     F: SemiApplicative<F>
   ) => <TR, TO, TE, R, O, E, A>(
     self: Kind<T, TR, TO, TE, Kind<F, R, O, E, A>>

diff --git a/docs/modules/typeclass/Of.ts.md b/docs/modules/typeclass/Of.ts.md
@@ -29,7 +29,7 @@ Added in v1.0.0
 
 ```ts
 export interface Of<F extends TypeLambda> extends TypeClass<F> {
-  of: <A>(a: A) => Kind<F, unknown, never, never, A>
+  readonly of: <A>(a: A) => Kind<F, unknown, never, never, A>
 }
 ```
 

diff --git a/docs/modules/typeclass/Order.ts.md b/docs/modules/typeclass/Order.ts.md
@@ -124,7 +124,7 @@ Added in v1.0.0
 
 ```ts
 export interface Order<A> {
-  compare: (that: A) => (self: A) => -1 | 0 | 1
+  readonly compare: (that: A) => (self: A) => -1 | 0 | 1
 }
 ```
 
@@ -138,7 +138,7 @@ Added in v1.0.0
 
 ```ts
 export interface OrderTypeLambda extends TypeLambda {
-  type: Order<this['Target']>
+  readonly type: Order<this['Target']>
 }
 ```
 
@@ -269,7 +269,7 @@ Given a tuple of `Compare`s returns a `Compare` for the tuple.
 **Signature**
 
 ```ts
-export declare const tuple: <A extends any[]>(...orders: { [K in keyof A]: Order<A[K]> }) => Order<Readonly<A>>
+export declare const tuple: <A extends readonly any[]>(...orders: { [K in keyof A]: Order<A[K]> }) => Order<Readonly<A>>
 ```
 
 Added in v1.0.0
diff --git a/docs/modules/typeclass/Product.ts.md b/docs/modules/typeclass/Product.ts.md
@@ -28,7 +28,7 @@ Added in v1.0.0
 
 ```ts
 export interface Product<F extends TypeLambda> extends SemiProduct<F>, Of<F> {
-  productAll: <R, O, E, A>(collection: Iterable<Kind<F, R, O, E, A>>) => Kind<F, R, O, E, Array<A>>
+  readonly productAll: <R, O, E, A>(collection: Iterable<Kind<F, R, O, E, A>>) => Kind<F, R, O, E, ReadonlyArray<A>>
 }
 ```
 
@@ -50,7 +50,7 @@ export declare const struct: <F extends TypeLambda>(
   [R[keyof R]] extends [Kind<F, infer R, any, any, any>] ? R : never,
   [R[keyof R]] extends [Kind<F, any, infer O, any, any>] ? O : never,
   [R[keyof R]] extends [Kind<F, any, any, infer E, any>] ? E : never,
-  { [K in keyof R]: [R[K]] extends [Kind<F, any, any, any, infer A>] ? A : never }
+  { readonly [K in keyof R]: [R[K]] extends [Kind<F, any, any, any, infer A>] ? A : never }
 >
 ```
 
@@ -63,14 +63,14 @@ Added in v1.0.0
 ```ts
 export declare const tuple: <F extends TypeLambda>(
   F: Product<F>
-) => <T extends Kind<F, any, any, any, any>[]>(
+) => <T extends readonly Kind<F, any, any, any, any>[]>(
   ...components: T
 ) => Kind<
   F,
   [T[number]] extends [Kind<F, infer R, any, any, any>] ? R : never,
   [T[number]] extends [Kind<F, any, infer O, any, any>] ? O : never,
   [T[number]] extends [Kind<F, any, any, infer E, any>] ? E : never,
-  { [I in keyof T]: [T[I]] extends [Kind<F, any, any, any, infer A>] ? A : never }
+  Readonly<{ [I in keyof T]: [T[I]] extends [Kind<F, any, any, any, infer A>] ? A : never }>
 >
 ```
 

diff --git a/docs/modules/typeclass/SemiCoproduct.ts.md b/docs/modules/typeclass/SemiCoproduct.ts.md
@@ -27,11 +27,11 @@ Added in v1.0.0
 
 ```ts
 export interface SemiCoproduct<F extends TypeLambda> extends Invariant<F> {
-  coproduct: <R2, O2, E2, B>(
+  readonly coproduct: <R2, O2, E2, B>(
     that: Kind<F, R2, O2, E2, B>
   ) => <R1, O1, E1, A>(self: Kind<F, R1, O1, E1, A>) => Kind<F, R1 & R2, O1 | O2, E1 | E2, A | B>
 
-  coproductMany: <R, O, E, A>(
+  readonly coproductMany: <R, O, E, A>(
     collection: Iterable<Kind<F, R, O, E, A>>
   ) => (self: Kind<F, R, O, E, A>) => Kind<F, R, O, E, A>
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -44,7 +44,7 @@ Added in v1.0.0 @@
     ```ts
     export interface Contravariant<F extends TypeLambda> extends Invariant<F> {
-      contramap: <B, A>(f: (b: B) => A) => <R, O, E>(self: Kind<F, R, O, E, A>) => Kind<F, R, O, E, B>
+      readonly contramap: <B, A>(f: (b: B) => A) => <R, O, E>(self: Kind<F, R, O, E, A>) => Kind<F, R, O, E, B>
     }
     ```
@@ Expand Down @@