Merge pull request #2 from typescript-package/develop

v1.0.0 updated docs

Author: wwwdev-ai

README.md

@@ -78,6 +78,11 @@ export class ActiveState extends BooleanState {
   }
 }
 
+// Initialize.
+const activeState = new ActiveState();
+
+// Deactivate the initial state.
+activeState.deactivate();
 ```
 
 ### `EnumState`
@@ -149,7 +154,7 @@ numberedState.increment();
 // Increment state by 5.
 numberedState.increment(5);
 
-// Reset state to 0..
+// Reset state to 0.
 numberedState.reset();
 ```
 

src/lib/boolean-state.abstract.ts

@@ -1,7 +1,7 @@
 // Abstract.
 import { State } from "./state.abstract";
 /**
- * @description Handles the boolean state.
+ * @description Handles the `boolean` type state.
  * @export
  * @abstract
  * @class BooleanState

src/lib/enum-state.abstract.ts

@@ -1,7 +1,7 @@
 // Abstract.
 import { State } from "./state.abstract";
 /**
- * @description
+ * @description Handles the `enum` type state.
  * @export
  * @abstract
  * @class EnumState
@@ -23,7 +23,13 @@ export abstract class EnumState<
   constructor(state: T, enumObject: EnumObject) {
     super(state);
   }
-
+  
+  /**
+   * @description Checks whether the state is of the specific enum.
+   * @public
+   * @param {T} state The specific enum to check whether state is.
+   * @returns {boolean}
+   */
   public is(state: T) {
     return super.state === state;
   }

src/lib/immutable-state.abstract.ts

@@ -1,5 +1,5 @@
 /**
- * @description
+ * @description Manages the immutability states of `this` current instance.
  * @export
  * @abstract
  * @class ImmutableState
@@ -26,7 +26,7 @@ export abstract class ImmutableState {
   }
 
   /**
-   * @description
+   * @description Checks whether `this` current instance is frozen.
    * @public
    * @returns {boolean}
    */
@@ -53,7 +53,7 @@ export abstract class ImmutableState {
   }
 
   /**
-   * @description 
+   * @description Checks whether `this` current instance is sealed.
    * @public
    * @returns {boolean}
    */

src/lib/null-state.abstract.ts

@@ -1,7 +1,7 @@
 // Abstract.
 import { State } from "./state.abstract";
 /**
- * @description
+ * @description Handles and manages the `null` type state.
  * @export
  * @abstract
  * @class NullState
@@ -19,7 +19,7 @@ export abstract class NullState extends State<null | undefined> {
   }
 
   /**
-   * @description
+   * @description Checks whether state is `null`.
    * @public
    * @returns {boolean}
    */
@@ -39,7 +39,7 @@ export abstract class NullState extends State<null | undefined> {
   }
 
   /**
-   * @description
+   * @description Removes the `null` state.
    * @public
    * @returns {this}
    */
@@ -48,64 +48,3 @@ export abstract class NullState extends State<null | undefined> {
     return this;
   }
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-// export abstract class NullState<T> {
-//   private state: T | null;
-
-//   constructor(initialState: T | null = null) {
-//     this.state = initialState;
-//   }
-
-//   public get value(): T | null {
-//     return this.state;
-//   }
-
-//   public set(value: T): this {
-//     this.state = value;
-//     return this;
-//   }
-
-//   public clear(): this {
-//     this.state = null;
-//     return this;
-//   }
-// }

src/lib/number-state.abstract.ts

@@ -1,7 +1,7 @@
 // Abstract.
 import { State } from "./state.abstract";
 /**
- * @description Handles the number state.
+ * @description Handles and manages the `number` type state.
  * @export
  * @abstract
  * @class NumberState

src/lib/state.abstract.ts

@@ -1,7 +1,7 @@
 // Abstract.
 import { ImmutableState } from "./immutable-state.abstract";
 /**
- * @description
+ * @description Common class for setting the state of `Type`.
  * @export
  * @abstract
  * @class State
@@ -11,7 +11,7 @@ import { ImmutableState } from "./immutable-state.abstract";
  */
 export abstract class State<Type> extends ImmutableState {
   /**
-   * @description
+   * @description Returns the current state of `Type`.
    * @public
    * @readonly
    * @type {Type}
@@ -21,7 +21,7 @@ export abstract class State<Type> extends ImmutableState {
   }
 
   /**
-   * @description
+   * @description Privately stored state of `Type`.
    * @private
    * @type {Type}
    */
@@ -30,7 +30,7 @@ export abstract class State<Type> extends ImmutableState {
   /**
    * Creates an instance of parent class.
    * @constructor
-   * @param {Type} [initialState]
+   * @param {Type} [initialState] Initial state of `Type`.
    */
   constructor(initialState: Type) {
     super();

src/test/boolean-state.spec.ts

@@ -18,3 +18,7 @@ export class ActiveState extends BooleanState {
     super.false();
   }
 }
+
+const activeState = new ActiveState();
+
+activeState.deactivate();