From 369c1dde7dd82d4c5a52671c08b798d20436ca75 Mon Sep 17 00:00:00 2001 From: Marshall Sorenson Date: Fri, 19 Jul 2024 10:00:17 -0400 Subject: [PATCH] chore: linting --- .../interfaces/password-creation-service.interface.ts | 2 +- .../user-password-history-service.interface.ts | 9 ++++----- packages/typeorm-common/src/services/base.service.ts | 6 +++--- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/packages/nestjs-password/src/interfaces/password-creation-service.interface.ts b/packages/nestjs-password/src/interfaces/password-creation-service.interface.ts index 6e6d82cd4..8ba38d571 100644 --- a/packages/nestjs-password/src/interfaces/password-creation-service.interface.ts +++ b/packages/nestjs-password/src/interfaces/password-creation-service.interface.ts @@ -35,7 +35,7 @@ export interface PasswordCreationServiceInterface { /** * Validate the array of password stores to check for previous usage. * - * @param options Validate history options. + * @param options - Validate history options. * @returns boolean Returns true if password has NOT been used withing configured range. */ validateHistory: ( diff --git a/packages/nestjs-user/src/interfaces/user-password-history-service.interface.ts b/packages/nestjs-user/src/interfaces/user-password-history-service.interface.ts index 70e0a1f7e..22562532e 100644 --- a/packages/nestjs-user/src/interfaces/user-password-history-service.interface.ts +++ b/packages/nestjs-user/src/interfaces/user-password-history-service.interface.ts @@ -7,8 +7,8 @@ export interface UserPasswordHistoryServiceInterface { * * Object must have reference id and password storage interface. * - * @param {ReferenceId} userId The id of the user - * @returns {Promise<(ReferenceIdInterface & PasswordStorageInterface)[]>} The password history for the user + * @param userId - The id of the user + * @returns The password history for the user */ getHistory: ( userId: ReferenceId, @@ -19,9 +19,8 @@ export interface UserPasswordHistoryServiceInterface { * * Object must have reference id and password storage interface. * - * @param {ReferenceId} userId The id of the user - * @param {PasswordStorageInterface} passwordStore One password history for the user - * @returns {Promise} + * @param userId - The id of the user + * @param passwordStore - One password history for the user */ pushHistory: ( userId: ReferenceId, diff --git a/packages/typeorm-common/src/services/base.service.ts b/packages/typeorm-common/src/services/base.service.ts index 51b38d5cc..125f35c63 100644 --- a/packages/typeorm-common/src/services/base.service.ts +++ b/packages/typeorm-common/src/services/base.service.ts @@ -26,8 +26,8 @@ export abstract class BaseService { /** * Find wrapper. * - * @param options Find many options - * @param queryOptions + * @param options - Find many options + * @param queryOptions - Query options */ async find( options: FindManyOptions, @@ -45,7 +45,7 @@ export abstract class BaseService { /** * Find One wrapper. * - * @param findOneOptions - Find options + * @param options - Find one options * @param queryOptions - Query options */ async findOne(