Merge pull request #99 from SwabianCoder/docs/95-add-jsdoc-to-ngx-too…

…lset-template-type-checker 📝 Added JSDoc comments to template-type-checker project
SwabianCoder · Aug 18, 2022 · 2c09bdb · 2c09bdb
2 parents aa6e762 + 10b514c
commit 2c09bdb
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 1 deletion.
diff --git a/projects/template-type-checker/CHANGELOG.md b/projects/template-type-checker/CHANGELOG.md
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0-rc.6] - 2022-08-18
+
+### Added
+
+- JSDoc comments
+
 ## [1.0.0-rc.5] - 2022-08-15
 
 ### Changed

diff --git a/projects/template-type-checker/package.json b/projects/template-type-checker/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ngx-toolset/template-type-checker",
-  "version": "1.0.0-rc.5",
+  "version": "1.0.0-rc.6",
   "description": "Validate object's class instance type in Angular HTML template",
   "homepage": "https://github.com/SwabianCoder/ngx-toolset",
   "license": "MIT",

diff --git a/projects/template-type-checker/src/lib/template-type-checker.module.ts b/projects/template-type-checker/src/lib/template-type-checker.module.ts
@@ -1,6 +1,13 @@
 import { NgModule } from '@angular/core';
 import { TypeCheckerPipe } from './type-checker.pipe';
 
+/**
+ * The TemplateTypeCheckerModule containing the {@link https://github.com/SwabianCoder/ngx-toolset/blob/main/projects/template-type-checker/src/lib/type-checker.pipe.ts TypeCheckerPipe}
+ *
+ * @export
+ * @class TemplateTypeCheckerModule
+ * @typedef {TemplateTypeCheckerModule}
+ */
 @NgModule({
   declarations: [TypeCheckerPipe],
   exports: [TypeCheckerPipe],

diff --git a/projects/template-type-checker/src/lib/type-checker.pipe.ts b/projects/template-type-checker/src/lib/type-checker.pipe.ts
@@ -1,10 +1,27 @@
 import { Pipe, PipeTransform } from '@angular/core';
 import { Constructor } from './types';
 
+/**
+ * The TypeCheckerPipe validates if an object is an instance of the provided {@link https://github.com/SwabianCoder/ngx-toolset/blob/main/projects/template-type-checker/src/lib/types/constructor.ts className}.
+ *
+ * @export
+ * @class TypeCheckerPipe
+ * @typedef {TypeCheckerPipe}
+ * @implements {PipeTransform}
+ */
 @Pipe({
   name: 'typeChecker',
 })
 export class TypeCheckerPipe implements PipeTransform {
+  /**
+   * Validates if an object is an instance of the provided {@link https://github.com/SwabianCoder/ngx-toolset/blob/main/projects/template-type-checker/src/lib/types/constructor.ts className}.
+   *
+   * @public
+   * @template T
+   * @param {*} obj
+   * @param {Constructor<T>} className
+   * @returns {(T | undefined)}
+   */
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public transform<T>(obj: any, className: Constructor<T>): T | undefined {
     return obj instanceof className ? obj : undefined;

diff --git a/projects/template-type-checker/src/lib/types/constructor.ts b/projects/template-type-checker/src/lib/types/constructor.ts
@@ -1,2 +1,9 @@
+/**
+ * Represents the class to validate the object against using {@link https://github.com/SwabianCoder/ngx-toolset/blob/main/projects/template-type-checker/src/lib/type-checker.pipe.ts TypeCheckerPipe}
+ *
+ * @export
+ * @typedef {Constructor}
+ * @template T
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type Constructor<T> = { new (...args: any[]): T };