Merge pull request #5 from typescript-package/develop

v2.1.0

Author: wwwdev-ai

README.md

@@ -20,6 +20,9 @@ A **lightweight** TypeScript library for the affix - prefix and suffix.
 
 - [Installation](#installation)
 - [Api](#api)
+  - [`Affix`](#affix)
+  - [`Prefix`](#prefix)
+  - [`Suffix`](#suffix)
 - [Contributing](#contributing)
 - [Support](#support)
 - [Code of Conduct](#code-of-conduct)

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@typescript-package/affix",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "author": "wwwdev.io <dev@wwwdev.io>",
   "description": "A lightweight TypeScript library for the affix - prefix and suffix.",
   "license": "MIT",
@@ -9,7 +9,7 @@
     "registry": "https://registry.npmjs.org"
   },
   "peerDependencies": {
-    "@typescript-package/core": "^1.2.0"
+    "@typescript-package/core": "^2.0.0"
   },
   "scripts": {
     "prepublishOnly": "npm run pkg && npm run clean",

package.json

@@ -9,6 +9,16 @@ import { Value } from '@typescript-package/core';
  * @extends {Value<Value>}
  */
 export abstract class Affix<Value extends string = string> extends Value<Value> {
+  /**
+   * @description Returns the `string` tag representation of the `Affix` class when used in `Object.prototype.toString.call(instance)`.
+   * @public
+   * @readonly
+   * @type {string}
+   */
+  public override get [Symbol.toStringTag]() {
+    return 'Affix';
+  }
+
   /**
    * @description Defines the affix sanitized by specified pattern.
    * @public
@@ -87,6 +97,7 @@ export abstract class Affix<Value extends string = string> extends Value<Value>
    * @description Sets the pattern to sanitize the affix.
    * @public
    * @param {RegExp} pattern The pattern of `RegExp` to sanitize the affix.
+   * @returns {this} 
    */
   public setPattern(pattern: RegExp): this {
     pattern instanceof RegExp && (this.#pattern = pattern);

src/lib/affix.abstract.ts

@@ -8,6 +8,16 @@ import { Affix } from "./affix.abstract";
  * @extends {Affix<Value>}
  */
 export class Prefix<Value extends string = string> extends Affix<Value> {
+  /**
+   * @description Returns the `string` tag representation of the `Prefix` class when used in `Object.prototype.toString.call(instance)`.
+   * @public
+   * @readonly
+   * @type {string}
+   */
+  public override get [Symbol.toStringTag]() {
+    return 'Prefix';
+  }
+
   /**
    * @description Sanitizes the prefix with a `pattern`.
    * @public

src/lib/prefix.class.ts

@@ -8,6 +8,16 @@ import { Affix } from "./affix.abstract";
  * @extends {Affix<Value>}
  */
 export class Suffix<Value extends string = string> extends Affix<Value> {
+  /**
+   * @description Returns the `string` tag representation of the `Suffix` class when used in `Object.prototype.toString.call(instance)`.
+   * @public
+   * @readonly
+   * @type {string}
+   */
+  public override get [Symbol.toStringTag]() {
+    return 'Suffix';
+  }
+
   /**
    * @description Sanitizes the suffix with a `pattern`.
    * @public

src/lib/suffix.class.ts

@@ -0,0 +1,10 @@
+import { typeOf } from "@typescript-package/core";
+import { Affix } from "../lib";
+
+export class TestAffix extends Affix {}
+
+const testAffix = new TestAffix();
+
+console.log(testAffix);
+console.log(`typeOf(), `, typeOf(testAffix));
+console.log(`[object Affix], `, Object.prototype.toString.call(testAffix).match(/\[object (\w+)]/)?.[1]);

src/test/affix.spec.ts

@@ -1,13 +1,18 @@
+import { typeOf } from '@typescript-package/core';
 import { Prefix } from '../lib/prefix.class';
 
 const prefix = new Prefix();
 
 console.group(`Prefix`);
+console.log(prefix);
 
 console.debug(`set('_')`, prefix.set('_'));
 console.debug(`get()`, prefix.get());
 console.debug(`value`, prefix.value);
 
+console.log(`typeOf(), `, typeOf(prefix));
+console.log(`[object Suffix], `, Object.prototype.toString.call(prefix));
+
 console.groupEnd();
 
 describe(Prefix.name, () => {

src/test/prefix.spec.ts

@@ -0,0 +1,8 @@
+import { typeOf } from "@typescript-package/core";
+import { Suffix } from "../lib";
+
+const suffix = new Suffix();
+
+console.log(suffix);
+console.log(`typeOf(), `, typeOf(suffix));
+console.log(`[object Suffix], `, Object.prototype.toString.call(suffix));