docs: remove impertinent Jsdocs comments (no-changelog) (#4181)

* 🔥 Remove impertinent Jsdocs comments

* Lint fixes
This commit is contained in:
agobrech
2022-09-29 14:37:56 +02:00
committed by GitHub
parent 64fffa0579
commit 8bd99e0600
77 changed files with 6 additions and 888 deletions

View File

@@ -19,7 +19,6 @@ import {
/**
* Special Error which allows to return also an error code and http status code
*
* @export
* @class ResponseError
* @extends {Error}
*/
@@ -41,7 +40,6 @@ export class ResponseError extends Error {
* @param {number} [errorCode] The error code which can be used by frontend to identify the actual error
* @param {number} [httpStatusCode] The HTTP status code the response should have
* @param {string} [hint] The error hint to provide a context (webhook related)
* @memberof ResponseError
*/
constructor(message: string, errorCode?: number, httpStatusCode?: number, hint?: string) {
super(message);
@@ -143,9 +141,7 @@ const isUniqueConstraintError = (error: Error) =>
* all the responses have the same format
*
*
* @export
* @param {(req: Request, res: Response) => Promise<any>} processFunction The actual function to process the request
* @returns
*/
export function send<T, R extends Request, S extends Response>(
@@ -173,9 +169,7 @@ export function send<T, R extends Request, S extends Response>(
* As it contains a lot of references which normally would be saved as duplicate data
* with regular JSON.stringify it gets flattened which keeps the references in place.
*
* @export
* @param {IExecutionDb} fullExecutionData The data to flatten
* @returns {IExecutionFlatted}
*/
export function flattenExecutionData(fullExecutionData: IExecutionDb): IExecutionFlatted {
// Flatten the data
@@ -210,9 +204,7 @@ export function flattenExecutionData(fullExecutionData: IExecutionDb): IExecutio
/**
* Unflattens the Execution data.
*
* @export
* @param {IExecutionFlattedDb} fullExecutionData The data to unflatten
* @returns {IExecutionResponse}
*/
export function unflattenExecutionData(fullExecutionData: IExecutionFlattedDb): IExecutionResponse {
const returnData: IExecutionResponse = {