Documentation updated.

Author: r37r0m0d3l

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### 1.3.1
+
+#### Update
+
+- Documentation updated
+
 ### 1.3.0
 
 #### Added

README.md

@@ -15,9 +15,7 @@ TypeScript common types.
 ### Complete
 
 ```typescript
-import type {
-  CompleteType
-} from '@corefunc/type/class/complete.type';
+import type { CompleteType } from "@corefunc/type/class/complete.type";
 interface UserInterface {
   name: string;
   zip: string;
@@ -29,10 +27,10 @@ class User implements CompleteType<UserInterface> {
 }
 ```
 
+### Concrete
+
 ```typescript
-import type {
-  ConcreteType
-} from '@corefunc/type/class/concrete.type';
+import type { ConcreteType } from "@corefunc/type/class/concrete.type";
 interface UserInterface {
   email: string;
   nickname?: string;
@@ -44,75 +42,79 @@ class User implements ConcreteType<UserInterface> {
 }
 ```
 
+### Constructor
+
+```typescript
+import type { ConstructorType } from "@corefunc/type/class/constructor.type";
+
+class ExchangeClient {}
+
+function mixinApiPostUser<T extends ConstructorType<ExchangeClient>>(superClass: T) {
+  return class extends superClass {
+    public postUser(data: any) {
+      return this.post(`/users/`, data);
+    }
+  };
+}
+
+function mixinApiGetUser<T extends ConstructorType<ExchangeClient>>(superClass: T) {
+  return class extends superClass {
+    public getUser(id: string) {
+      return this.get(`/users/${id}`);
+    }
+  };
+}
+
+class ApiClient extends mixinApiPostUser(mixinApiGetUser(ExchangeClient)) {}
+```
+
 ## Number
 
 ### Float
 
 ```typescript
-import {
-  isFloatRange, assertFloatRange
-} from '@corefunc/type';
-import {
-  TypeFloatRange, FloatRangeType, FloatRange
-} from '@corefunc/type';
-const value: TypeFloatRange<0.01, 99.99> = 10.50;
+import { isFloatRange, assertFloatRange } from "@corefunc/type";
+import { TypeFloatRange, FloatRangeType, FloatRange } from "@corefunc/type";
+const value: TypeFloatRange<0.01, 99.99> = 10.5;
 ```
 
 ### Integer 16
 
 ```typescript
-import {
-  isInteger16, assertInteger16, INT16, INT16_MAX, INT16_MIN
-} from '@corefunc/type';
-import type {
-  TypeInteger16, Integer16Type, Integer16
-} from '@corefunc/type';
+import { isInteger16, assertInteger16, INT16, INT16_MAX, INT16_MIN } from "@corefunc/type";
+import type { TypeInteger16, Integer16Type, Integer16 } from "@corefunc/type";
 const value: TypeInteger16 = 32_767;
 ```
 
 ### Integer 32
 
 ```typescript
-import {
-  isInteger32, assertInteger32, INT32, INT32_MAX, INT32_MIN
-} from '@corefunc/type';
-import type {
-  TypeInteger32, Integer32Type, Integer32
-} from '@corefunc/type';
+import { isInteger32, assertInteger32, INT32, INT32_MAX, INT32_MIN } from "@corefunc/type";
+import type { TypeInteger32, Integer32Type, Integer32 } from "@corefunc/type";
 const value: TypeInteger32 = 2_147_483_647;
 ```
 
 ### Integer 64
 
 ```typescript
-import {
-  isInteger64, assertInteger64, INT64, INT64_MAX, INT64_MIN
-} from '@corefunc/type';
-import type {
-  TypeInteger64, Integer64Type, Integer64
-} from '@corefunc/type';
+import { isInteger64, assertInteger64, INT64, INT64_MAX, INT64_MIN } from "@corefunc/type";
+import type { TypeInteger64, Integer64Type, Integer64 } from "@corefunc/type";
 const value: TypeInteger64 = 9_223_372_036_854_775_807;
 ```
 
 ### Integer Range
 
 ```typescript
-import {
-  isIntegerRange, assertIntegerRange
-} from '@corefunc/type';
-import type {
-  TypeIntegerRange, IntegerRangeType, IntegerRange
-} from '@corefunc/type';
+import { isIntegerRange, assertIntegerRange } from "@corefunc/type";
+import type { TypeIntegerRange, IntegerRangeType, IntegerRange } from "@corefunc/type";
 const value: TypeIntegerRange<0, 100> = 50;
 ```
 
 ### Numeric
 
 ```typescript
-import { isNumeric, assertNumeric } from '@corefunc/type';
-import type {
-  TypeNumeric, NumericType, Numeric
-} from '@corefunc/type';
+import { isNumeric, assertNumeric } from "@corefunc/type";
+import type { TypeNumeric, NumericType, Numeric } from "@corefunc/type";
 const value: TypeNumeric<5, 2> = 999.99;
 ```
 
@@ -121,80 +123,56 @@ const value: TypeNumeric<5, 2> = 999.99;
 ### String Date
 
 ```typescript
-import {
-  isStringDate, assertStringDate
-} from '@corefunc/type';
-import type {
-  TypeStringDate, StringDateType, StringDate
-} from '@corefunc/type';
+import { isStringDate, assertStringDate } from "@corefunc/type";
+import type { TypeStringDate, StringDateType, StringDate } from "@corefunc/type";
 const value: StringDate = "2020-01-01";
 ```
 
 ### String Fixed
 
 ```typescript
-import {
-  isStringFixed, assertStringFixed
-} from '@corefunc/type';
-import type {
- TypeStringFixed, StringFixedType, StringFixed
-} from '@corefunc/type';
+import { isStringFixed, assertStringFixed } from "@corefunc/type";
+import type { TypeStringFixed, StringFixedType, StringFixed } from "@corefunc/type";
 const value: StringFixed<3> = "USD";
 ```
 
 ### String Of Length
 
 ```typescript
-import {
-  isStringOfLength, assertStringOfLength
-} from '@corefunc/type';
-import type {
-  TypeStringOfLength, StringOfLengthType, StringOfLength
-} from '@corefunc/type';
+import { isStringOfLength, assertStringOfLength } from "@corefunc/type";
+import type { TypeStringOfLength, StringOfLengthType, StringOfLength } from "@corefunc/type";
 const value: StringOfLength<2, 99> = "Billy";
 ```
 
 ### String Time
 
 ```typescript
-import {
-  isStringTime, assertStringTime
-} from '@corefunc/type';
-import type {
-  TypeStringTime, StringTimeType, StringTime
-} from '@corefunc/type';
+import { isStringTime, assertStringTime } from "@corefunc/type";
+import type { TypeStringTime, StringTimeType, StringTime } from "@corefunc/type";
 const value: StringTime = "12:59";
 ```
 
 ### String Varying
 
 ```typescript
-import {
-  isStringVarying, assertStringVarying
-} from '@corefunc/type';
-import type {
-  TypeStringVarying, StringVaryingType, StringVarying
-} from '@corefunc/type';
+import { isStringVarying, assertStringVarying } from "@corefunc/type";
+import type { TypeStringVarying, StringVaryingType, StringVarying } from "@corefunc/type";
 const value: StringVarying<254> = "user+inbox@domain";
 ```
 
 ### UUID
 
 ```typescript
-import { isUuid, assertUuid } from '@corefunc/type';
-import type {
-  TypeUUID, UUIDType, UUID
-} from '@corefunc/type';
+import { isUuid, assertUuid } from "@corefunc/type";
+import type { TypeUUID, UUIDType, UUID } from "@corefunc/type";
 const value: UUID = "0b0bc0f0-db42-11eb-8d19-0242ac130003";
 ```
 
 ### UUID 4
 
 ```typescript
-import { isUuid4, assertUuid4 } from '@corefunc/type';
-import type {
-  TypeUUID4, UUID4Type, UUID4
-} from '@corefunc/type';
+import { isUuid4, assertUuid4 } from "@corefunc/type";
+import type { TypeUUID4, UUID4Type, UUID4 } from "@corefunc/type";
 const value: UUID4 = "155fbaaf-09de-4141-80df-94696eed4cb6";
 ```
 

class/constructor.type.d.ts

@@ -1 +1,6 @@
+/**
+ * @description Generic constructor type.
+ * @summary ```import type { ConstructorType } from '@corefunc/type/class/constructor.type';```
+ * @since 1.3.0
+ */
 export declare type ConstructorType<T> = new (...args: any[]) => T;

class/constructor.type.ts

@@ -1 +1,6 @@
+/**
+ * @description Generic constructor type.
+ * @summary ```import type { ConstructorType } from '@corefunc/type/class/constructor.type';```
+ * @since 1.3.0
+ */
 export type ConstructorType<T> = new (...args: any[]) => T;