Merge pull request #3 from gdman/feature/fileDelete

Add delete method to File class

src/core/file.ts

@@ -112,6 +112,22 @@ export class File {
 		}
 	};
 
+	public delete = async (): Promise<void> => {
+		try {
+			const file = this.getFile();
+
+			if (!fs.existsSync(file)) {
+				throw new Error('File not found');
+			}
+
+			await fs.promises.unlink(file);
+
+			return Promise.resolve();
+		} catch (ex) {
+			return Promise.reject('Delete failed: ' + (ex.message || ex));
+		}
+	}
+
 	private getParser = (): ParserInterface => {
 		if (this.parser) {
 			return this.parser;

test/core/file.test.ts

@@ -3,6 +3,7 @@ import { File } from "../../src/core";
 import { JsonParser, StringParser } from "../../src/parsers";
 import { DataType, Metadata } from "../../src/types";
 import { createTestFile, getTestFilePath, readTestFile } from "../test-utils/file-utils";
+import * as fs from 'fs';
 
 class NullBuilder implements BuilderInterface {
 	build(data: Metadata): Promise<string> {
@@ -251,4 +252,16 @@ describe('File', () => {
 			readTestFile(testFile)
 		).toBe('');
 	});
+
+	it('delete file that exists is successful', async () => {
+		const testFile = createTestFile('txt', 'value');
+
+		await new File(testFile).delete();
+
+		expect(fs.existsSync(testFile)).toBe(false);
+	});
+
+	it('delete file that doesnt exist rejects', () => {
+		return expect(new File('doesnt-exist').delete()).rejects.toBe('Delete failed: File not found');
+	});
 });