docs

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

src/validation/baseValidator.ts

@@ -21,15 +21,17 @@ import type { Version } from '../spec'
 
 export interface Validator {
   /**
-   * Promise rejects with one of the following
+   * validate the data.
+   *
+   * Promise may reject with one of the following:
    * - {@link Validation.NotImplementedError | NotImplementedError} when there is no validator available for `this.version`
    * - {@link Validation.MissingOptionalDependencyError | MissingOptionalDependencyError} when a required dependency was not installed
    * - {@link Validation.ValidationError | ValidationError} when `data` was invalid to the schema
    */
   validate: (data: string) => Promise<void>
 }
 
-export abstract class BaseValidator implements BaseValidator {
+export abstract class BaseValidator implements Validator {
   readonly #version: Version
 
   constructor (version: Version) {
@@ -40,5 +42,6 @@ export abstract class BaseValidator implements BaseValidator {
     return this.#version
   }
 
+  /** {@inheritDoc Validator.validate} */
   abstract validate (data: string): Promise<void>
 }

src/validation/index.node.ts

@@ -21,7 +21,7 @@ export * from './index.common'
 
 // region node-specifics
 
-export * from './jsonValidator'
+export * from './jsonValidator.node'
 export * from './xmlValidator.node'
 
 // endregion node-specifics

src/validation/index.web.ts

@@ -21,9 +21,7 @@ export * from './index.common'
 
 // region web-specifics
 
-// json validator is notentirely tested fr WEB, yet
-// export * from './jsonValidator'
-
-// there is no XML validator for the web, yet
+// there is no JSON validator for the web, yet
+// there is no XML  validator for the web, yet
 
 // endregion web-specifics

src/validation/jsonValidator.ts renamed to src/validation/jsonValidator.node.ts

@@ -99,7 +99,9 @@ abstract class BaseJsonValidator extends BaseValidator {
   }
 
   /**
-   * Promise rejects with one of the following
+   * Validate the data against CycloneDX spec of `this.version`.
+   *
+   * Promise may reject with one of the following:
    * - {@link Validation.NotImplementedError | NotImplementedError} when there is no validator available for `this.version`
    * - {@link Validation.MissingOptionalDependencyError | MissingOptionalDependencyError} when a required dependency was not installed
    * - {@link Validation.ValidationError | ValidationError} when `data` was invalid to the schema

src/validation/xmlValidator.node.ts

@@ -73,7 +73,9 @@ export class XmlValidator extends BaseValidator {
   }
 
   /**
-   * Promise rejects with one of the following
+   * Validate the data against CycloneDX spec of `this.version`.
+   *
+   * Promise may reject with one of the following:
    * - {@link Validation.NotImplementedError | NotImplementedError} when there is no validator available for `this.version`
    * - {@link Validation.MissingOptionalDependencyError | MissingOptionalDependencyError} when a required dependency was not installed
    * - {@link Validation.ValidationError | ValidationError} when `data` was invalid to the schema