fix: Added Javadoc to `removeGPS`

Resolves Deepsource JS-D1001
pull/160/head
tycrek 2 years ago
parent f36acef1cc
commit f1f8468651
No known key found for this signature in database
GPG Key ID: 25D74F3943625263

@ -5,6 +5,10 @@
import { removeLocation } from '@xoi/gps-metadata-remover'; import { removeLocation } from '@xoi/gps-metadata-remover';
import fs from 'fs-extra'; 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<boolean> => { export const removeGPS = (file: string): Promise<boolean> => {
return new Promise((resolve, reject) => return new Promise((resolve, reject) =>
fs.open(file, 'r+') fs.open(file, 'r+')

Loading…
Cancel
Save