Merge pull request #17337 from Se3do/fix/doc-and-pipe-cleanup

Fix/doc and pipe cleanup

Author: kamilmysliwiec

packages/common/exceptions/misdirected.exception.ts

@@ -22,7 +22,7 @@ export class MisdirectedException extends HttpException {
    *
    * By default, the JSON response body contains two properties:
    * - `statusCode`: this will be the value 421.
-   * - `message`: the string `'Bad Gateway'` by default; override this by supplying
+   * - `message`: the string `'Misdirected'` by default; override this by supplying
    * a string in the `objectOrError` parameter.
    *
    * If the parameter `objectOrError` is a string, the response body will contain an

packages/common/exceptions/not-acceptable.exception.ts

@@ -22,8 +22,8 @@ export class NotAcceptableException extends HttpException {
    *
    * By default, the JSON response body contains two properties:
    * - `statusCode`: this will be the value 406.
-   * - `error`: the string `'Not Acceptable'` by default; override this by supplying
-   * a string in the `error` parameter.
+   * - `message`: the string `'Not Acceptable'` by default; override this by supplying
+   * a string in the `objectOrError` parameter.
    *
    * If the parameter `objectOrError` is a string, the response body will contain an
    * additional property, `error`, with a short description of the HTTP error. To override the

packages/common/pipes/parse-array.pipe.ts

@@ -16,7 +16,7 @@ const DEFAULT_ARRAY_SEPARATOR = ',';
 /**
  * @publicApi
  */
-export interface ParseArrayOptions extends Omit<
+export interface ParseArrayPipeOptions extends Omit<
   ValidationPipeOptions,
   'transform' | 'validateCustomDecorators' | 'exceptionFactory'
 > {
@@ -43,6 +43,9 @@ export interface ParseArrayOptions extends Omit<
   exceptionFactory?: (error: any) => any;
 }
 
+/** @deprecated Use `ParseArrayPipeOptions` instead. */
+export type ParseArrayOptions = ParseArrayPipeOptions;
+
 /**
  * Defines the built-in ParseArray Pipe
  *
@@ -55,7 +58,9 @@ export class ParseArrayPipe implements PipeTransform {
   protected readonly validationPipe: ValidationPipe;
   protected exceptionFactory: (error: string) => any;
 
-  constructor(@Optional() protected readonly options: ParseArrayOptions = {}) {
+  constructor(
+    @Optional() protected readonly options: ParseArrayPipeOptions = {},
+  ) {
     this.validationPipe = new ValidationPipe({
       transform: true,
       validateCustomDecorators: true,

packages/common/pipes/parse-date.pipe.ts

@@ -7,6 +7,9 @@ import {
 } from '../utils/http-error-by-code.util';
 import { isNil } from '../utils/shared.utils';
 
+/**
+ * @publicApi
+ */
 export interface ParseDatePipeOptions {
   /**
    * If true, the pipe will return null or undefined if the value is not provided
@@ -30,6 +33,9 @@ export interface ParseDatePipeOptions {
   exceptionFactory?: (error: string) => any;
 }
 
+/**
+ * @publicApi
+ */
 @Injectable()
 export class ParseDatePipe implements PipeTransform<
   string | number | undefined | null