feat: make result for version command type safe

PDMLab · Apr 14, 2021 · a7da038 · a7da038
1 parent 90421b7
commit a7da038
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 5 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -14,6 +14,10 @@ export type DockerComposePortResult = {
   port: number
 }
 
+export type DockerComposeVersionResult = {
+  version: string
+}
+
 export interface IDockerComposeLogOptions extends IDockerComposeOptions {
   follow?: boolean
 }
@@ -377,8 +381,17 @@ export const port = async function (
   }
 }
 
-export const version = function (
+export const version = async function (
   options?: IDockerComposeOptions
-): Promise<IDockerComposeResult> {
-  return execCompose('version', ['--short'], options)
+): Promise<TypedDockerComposeResult<DockerComposeVersionResult>> {
+  try {
+    const result = await execCompose('version', ['--short'], options)
+    const version = result.out.replace('\n', '')
+    return {
+      ...result,
+      data: { version }
+    }
+  } catch (error) {
+    return Promise.reject(error)
+  }
 }
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -641,7 +641,7 @@ test('removes container', async (): Promise<void> => {
 })
 
 test('returns version information', async (): Promise<void> => {
-  const version = await compose.version()
+  const version = await (await compose.version()).data.version
 
-  expect(version.out).toBeTruthy()
+  expect(version).toMatch(/^(\d+\.)?(\d+\.)?(\*|\d+)$/)
 })