chore: use an inteface for container listing options

Author: elibosley

api/src/core/modules/docker/get-docker-containers.ts

@@ -1,7 +1,6 @@
 import fs from 'fs';
 
 import camelCaseKeys from 'camelcase-keys';
-import { ContainerInfo } from 'dockerode';
 
 import type { ContainerPort, Docker, DockerContainer } from '@app/graphql/generated/api/types.js';
 import { dockerLogger } from '@app/core/log.js';
@@ -11,13 +10,16 @@ import { ContainerPortType, ContainerState } from '@app/graphql/generated/api/ty
 import { getters, store } from '@app/store/index.js';
 import { updateDockerState } from '@app/store/modules/docker.js';
 
+export interface ContainerListingOptions {
+    useCache?: boolean;
+}
+
 /**
  * Get all Docker containers.
  * @returns All the in/active Docker containers on the system.
  */
-
 export const getDockerContainers = async (
-    { useCache } = { useCache: true }
+    { useCache }: ContainerListingOptions = { useCache: true }
 ): Promise<Array<DockerContainer>> => {
     const dockerState = getters.docker();
     if (useCache && dockerState.containers) {

api/src/unraid-api/graph/resolvers/docker/docker.service.ts

@@ -1,19 +1,22 @@
 import { Injectable } from '@nestjs/common';
 
 import type { DockerContainer } from '@app/graphql/generated/api/types.js';
-import { getDockerContainers } from '@app/core/modules/docker/get-docker-containers.js';
+import {
+    ContainerListingOptions,
+    getDockerContainers,
+} from '@app/core/modules/docker/get-docker-containers.js';
 import { docker } from '@app/core/utils/clients/docker.js';
 
 @Injectable()
 export class DockerService {
-    public async getContainers(useCache = false): Promise<DockerContainer[]> {
+    public async getContainers({ useCache }: ContainerListingOptions): Promise<DockerContainer[]> {
         return getDockerContainers({ useCache });
     }
 
     public async startContainer(id: string): Promise<DockerContainer> {
         const container = docker.getContainer(id);
         await container.start();
-        const containers = await this.getContainers(false);
+        const containers = await this.getContainers({ useCache: false });
         const updatedContainer = containers.find((c) => c.id === id);
         if (!updatedContainer) {
             throw new Error(`Container ${id} not found after starting`);
@@ -24,7 +27,7 @@ export class DockerService {
     public async stopContainer(id: string): Promise<DockerContainer> {
         const container = docker.getContainer(id);
         await container.stop();
-        const containers = await this.getContainers(false);
+        const containers = await this.getContainers({ useCache: false });
         const updatedContainer = containers.find((c) => c.id === id);
         if (!updatedContainer) {
             throw new Error(`Container ${id} not found after stopping`);