From f1f8468651863a6295a040ade1bed1894dac27bc Mon Sep 17 00:00:00 2001 From: tycrek Date: Thu, 13 Oct 2022 22:29:35 -0600 Subject: [PATCH] fix: Added Javadoc to `removeGPS` Resolves Deepsource JS-D1001 --- src/nightmare.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/nightmare.ts b/src/nightmare.ts index 9e91e11..d41eb9a 100644 --- a/src/nightmare.ts +++ b/src/nightmare.ts @@ -5,6 +5,10 @@ import { removeLocation } from '@xoi/gps-metadata-remover'; import fs from 'fs-extra'; +/** + * This strips GPS EXIF data from files using the @xoi/gps-metadata-remover package + * @returns A Promise that resolves to `true` if GPS data was removed, `false` if not + */ export const removeGPS = (file: string): Promise => { return new Promise((resolve, reject) => fs.open(file, 'r+')