deprecate type / fromType in favour of struct / fromStruct

Author: gcanti

CHANGELOG.md

@@ -19,6 +19,9 @@
 - **Experimental**
   - `Schemable`
     - (\*) add `readonly` combinator (@gcanti)
+    - (\*) add `struct` combinator (@gcanti)
+  - deprecate `type` in favour of `struct` (@gcanti)
+  - deprecate `fromType` in favour of `fromStruct` (@gcanti)
 
 (\*) breaking change
 

docs/modules/Codec.ts.md

@@ -27,19 +27,21 @@ Added in v2.2.3
   - [fromArray](#fromarray)
   - [fromPartial](#frompartial)
   - [fromRecord](#fromrecord)
+  - [fromStruct](#fromstruct)
   - [fromSum](#fromsum)
   - [fromTuple](#fromtuple)
-  - [fromType](#fromtype)
   - [intersect](#intersect)
   - [lazy](#lazy)
   - [mapLeftWithInput](#mapleftwithinput)
   - [nullable](#nullable)
   - [partial](#partial)
   - [record](#record)
   - [refine](#refine)
+  - [struct](#struct)
   - [sum](#sum)
   - [tuple](#tuple)
-  - [type](#type)
+  - [~~fromType~~](#fromtype)
+  - [~~type~~](#type)
 - [constructors](#constructors)
   - [fromDecoder](#fromdecoder)
   - [literal](#literal)
@@ -137,6 +139,18 @@ export declare function fromRecord<I, O, A>(
 
 Added in v2.2.3
 
+## fromStruct
+
+**Signature**
+
+```ts
+export declare function fromStruct<P extends Record<string, Codec<any, any, any>>>(
+  properties: P
+): Codec<{ [K in keyof P]: InputOf<P[K]> }, { [K in keyof P]: OutputOf<P[K]> }, { [K in keyof P]: TypeOf<P[K]> }>
+```
+
+Added in v2.2.15
+
 ## fromSum
 
 **Signature**
@@ -167,18 +181,6 @@ export declare const fromTuple: <C extends readonly Codec<any, any, any>[]>(
 
 Added in v2.2.8
 
-## fromType
-
-**Signature**
-
-```ts
-export declare function fromType<P extends Record<string, Codec<any, any, any>>>(
-  properties: P
-): Codec<{ [K in keyof P]: InputOf<P[K]> }, { [K in keyof P]: OutputOf<P[K]> }, { [K in keyof P]: TypeOf<P[K]> }>
-```
-
-Added in v2.2.8
-
 ## intersect
 
 **Signature**
@@ -260,6 +262,18 @@ export declare const refine: <A, B extends A>(
 
 Added in v2.2.3
 
+## struct
+
+**Signature**
+
+```ts
+export declare function struct<P extends Record<string, Codec<unknown, any, any>>>(
+  properties: P
+): Codec<unknown, { [K in keyof P]: OutputOf<P[K]> }, { [K in keyof P]: TypeOf<P[K]> }>
+```
+
+Added in v2.2.15
+
 ## sum
 
 **Signature**
@@ -286,14 +300,26 @@ export declare function tuple<C extends ReadonlyArray<Codec<unknown, any, any>>>
 
 Added in v2.2.3
 
-## type
+## ~~fromType~~
+
+Use `fromStruct` instead.
 
 **Signature**
 
 ```ts
-export declare function type<P extends Record<string, Codec<unknown, any, any>>>(
-  properties: P
-): Codec<unknown, { [K in keyof P]: OutputOf<P[K]> }, { [K in keyof P]: TypeOf<P[K]> }>
+export declare const fromType: typeof fromStruct
+```
+
+Added in v2.2.8
+
+## ~~type~~
+
+Use `struct` instead.
+
+**Signature**
+
+```ts
+export declare const type: typeof struct
 ```
 
 Added in v2.2.3

docs/modules/Decoder.ts.md

@@ -37,9 +37,9 @@ Added in v2.2.7
   - [fromArray](#fromarray)
   - [fromPartial](#frompartial)
   - [fromRecord](#fromrecord)
+  - [fromStruct](#fromstruct)
   - [fromSum](#fromsum)
   - [fromTuple](#fromtuple)
-  - [fromType](#fromtype)
   - [intersect](#intersect)
   - [lazy](#lazy)
   - [mapLeftWithInput](#mapleftwithinput)
@@ -49,11 +49,13 @@ Added in v2.2.7
   - [readonly](#readonly)
   - [record](#record)
   - [refine](#refine)
+  - [struct](#struct)
   - [sum](#sum)
   - [tuple](#tuple)
-  - [type](#type)
   - [union](#union)
   - [withMessage](#withmessage)
+  - [~~fromType~~](#fromtype)
+  - [~~type~~](#type)
 - [constructors](#constructors)
   - [fromGuard](#fromguard)
   - [fromRefinement](#fromrefinement)
@@ -223,6 +225,18 @@ export declare const fromRecord: <I, A>(codomain: Decoder<I, A>) => Decoder<Reco
 
 Added in v2.2.8
 
+## fromStruct
+
+**Signature**
+
+```ts
+export declare const fromStruct: <P extends Record<string, Decoder<any, any>>>(
+  properties: P
+) => Decoder<{ [K in keyof P]: K.InputOf<'Either', P[K]> }, { [K in keyof P]: K.TypeOf<'Either', P[K]> }>
+```
+
+Added in v2.2.15
+
 ## fromSum
 
 **Signature**
@@ -249,18 +263,6 @@ export declare const fromTuple: <C extends readonly Decoder<any, any>[]>(
 
 Added in v2.2.8
 
-## fromType
-
-**Signature**
-
-```ts
-export declare const fromType: <P extends Record<string, Decoder<any, any>>>(
-  properties: P
-) => Decoder<{ [K in keyof P]: K.InputOf<'Either', P[K]> }, { [K in keyof P]: K.TypeOf<'Either', P[K]> }>
-```
-
-Added in v2.2.8
-
 ## intersect
 
 **Signature**
@@ -362,6 +364,18 @@ export declare const refine: <A, B extends A>(
 
 Added in v2.2.7
 
+## struct
+
+**Signature**
+
+```ts
+export declare const struct: <A>(
+  properties: { [K in keyof A]: Decoder<unknown, A[K]> }
+) => Decoder<unknown, { [K in keyof A]: A[K] }>
+```
+
+Added in v2.2.15
+
 ## sum
 
 **Signature**
@@ -386,18 +400,6 @@ export declare const tuple: <A extends readonly unknown[]>(
 
 Added in v2.2.7
 
-## type
-
-**Signature**
-
-```ts
-export declare const type: <A>(
-  properties: { [K in keyof A]: Decoder<unknown, A[K]> }
-) => Decoder<unknown, { [K in keyof A]: A[K] }>
-```
-
-Added in v2.2.7
-
 ## union
 
 **Signature**
@@ -422,6 +424,34 @@ export declare const withMessage: <I>(
 
 Added in v2.2.9
 
+## ~~fromType~~
+
+Use `fromStruct` instead.
+
+**Signature**
+
+```ts
+export declare const fromType: <P extends Record<string, Decoder<any, any>>>(
+  properties: P
+) => Decoder<{ [K in keyof P]: K.InputOf<'Either', P[K]> }, { [K in keyof P]: K.TypeOf<'Either', P[K]> }>
+```
+
+Added in v2.2.8
+
+## ~~type~~
+
+Use `struct` instead.
+
+**Signature**
+
+```ts
+export declare const type: <A>(
+  properties: { [K in keyof A]: Decoder<unknown, A[K]> }
+) => Decoder<unknown, { [K in keyof A]: A[K] }>
+```
+
+Added in v2.2.7
+
 # constructors
 
 ## fromGuard

docs/modules/Encoder.ts.md

@@ -32,9 +32,10 @@ Added in v2.2.3
   - [nullable](#nullable)
   - [partial](#partial)
   - [record](#record)
+  - [struct](#struct)
   - [sum](#sum)
   - [tuple](#tuple)
-  - [type](#type)
+  - [~~type~~](#type)
 - [instances](#instances)
   - [Category](#category-1)
   - [Contravariant](#contravariant-1)
@@ -148,6 +149,18 @@ export declare function record<O, A>(codomain: Encoder<O, A>): Encoder<Record<st
 
 Added in v2.2.3
 
+## struct
+
+**Signature**
+
+```ts
+export declare function struct<P extends Record<string, Encoder<any, any>>>(
+  properties: P
+): Encoder<{ [K in keyof P]: OutputOf<P[K]> }, { [K in keyof P]: TypeOf<P[K]> }>
+```
+
+Added in v2.2.15
+
 ## sum
 
 **Signature**
@@ -172,14 +185,14 @@ export declare function tuple<C extends ReadonlyArray<Encoder<any, any>>>(
 
 Added in v2.2.3
 
-## type
+## ~~type~~
+
+Use `struct` instead.
 
 **Signature**
 
 ```ts
-export declare function type<P extends Record<string, Encoder<any, any>>>(
-  properties: P
-): Encoder<{ [K in keyof P]: OutputOf<P[K]> }, { [K in keyof P]: TypeOf<P[K]> }>
+export declare const type: typeof struct
 ```
 
 Added in v2.2.3

docs/modules/Eq.ts.md

@@ -27,9 +27,10 @@ Added in v2.2.2
   - [partial](#partial)
   - [readonly](#readonly)
   - [record](#record)
+  - [struct](#struct)
   - [sum](#sum)
   - [tuple](#tuple)
-  - [type](#type)
+  - [~~type~~](#type)
 - [instances](#instances)
   - [Schemable](#schemable)
   - [WithRefine](#withrefine)
@@ -118,6 +119,16 @@ export declare const record: <A>(codomain: E.Eq<A>) => E.Eq<Record<string, A>>
 
 Added in v2.2.2
 
+## struct
+
+**Signature**
+
+```ts
+export declare const struct: <A>(eqs: { [K in keyof A]: E.Eq<A[K]> }) => E.Eq<{ [K in keyof A]: A[K] }>
+```
+
+Added in v2.2.15
+
 ## sum
 
 **Signature**
@@ -140,7 +151,9 @@ export declare const tuple: <A extends readonly unknown[]>(...components: { [K i
 
 Added in v2.2.2
 
-## type
+## ~~type~~
+
+Use `struct` instead.
 
 **Signature**