refactor(db): align variable names for limit and offset

This is not a breaking change despite the variable names changing in the interface/implementation as typescript doesn't enforce the parameter names.
open-amt-cloud-toolkit · Sep 14, 2023 · ce3c9da · ce3c9da
1 parent b3bed90
commit ce3c9da
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/src/data/postgres/tables/device.ts b/src/data/postgres/tables/device.ts
@@ -32,7 +32,7 @@ export class DeviceTable implements IDeviceTable {
    * @description Get all devices from DB
    * @returns {Device[]} returns an array of objects
    */
-  async get (top: number = DefaultTop, skip: number = DefaultSkip, tenantId: string = ''): Promise<Device[]> {
+  async get (limit: number = DefaultTop, offset: number = DefaultSkip, tenantId: string = ''): Promise<Device[]> {
     const results = await this.db.query<Device>(`
     SELECT 
       guid as "guid",
@@ -47,7 +47,7 @@ export class DeviceTable implements IDeviceTable {
     FROM devices
     WHERE tenantid = $3 
     ORDER BY guid 
-    LIMIT $1 OFFSET $2`, [top, skip, tenantId])
+    LIMIT $1 OFFSET $2`, [limit, offset, tenantId])
     return results.rows
   }
 

diff --git a/src/interfaces/IDeviceTable.ts b/src/interfaces/IDeviceTable.ts
@@ -9,7 +9,7 @@ import { type ITable } from './ITable'
 export interface IDeviceTable extends ITable<Device> {
   getConnectedDevices: (tenantId?: string) => Promise<number>
   getDistinctTags: (tenantId?: string) => Promise<string[]>
-  getByTags: (tags: string[], method: string, top: number, skip: number, tenantId?: string) => Promise<Device[]>
+  getByTags: (tags: string[], method: string, limit: number | string, offset: number | string, tenantId?: string) => Promise<Device[]>
   getByFriendlyName: (hostname: string, tenantId?: string) => Promise<Device[]>
   getByHostname: (hostname: string, tenantId?: string) => Promise<Device[]>
   clearInstanceStatus: (mpsInstance: string, tenantId?: string) => Promise<boolean>

diff --git a/src/interfaces/ITable.ts b/src/interfaces/ITable.ts
@@ -5,7 +5,7 @@
 
 export interface ITable<T> {
   getCount: (tenantId?: string) => Promise<number>
-  get: (limit: number, offset: number, tenantId?: string) => Promise<T[]>
+  get: (limit: number | string, offset: number | string, tenantId?: string) => Promise<T[]>
   getById: (id: string, tenantId?: string) => Promise<T>
   delete: (name: string, tenantId?: string) => Promise<boolean>
   insert: (item: T) => Promise<T>