@brianbuie/node-kit 0.5.0 → 0.5.1

package/dist/Cache.d.ts

@@ -11,6 +11,7 @@ export declare class Cache<T> {
         file: import("./File.js").File;
         get exists(): boolean;
         get path(): string;
+        delete(): void;
     };
     ttl: number;
     refresh: () => T | Promise<T>;

package/dist/File.d.ts

@@ -13,10 +13,11 @@ export declare class File {
      * @returns lines as strings, removes trailing '\n'
      */
     lines(): string[];
+    delete(): void;
     static get Adaptor(): typeof FileAdaptor;
     json<T>(contents?: T): JsonFile<T>;
     static get json(): typeof JsonFile;
-    ndjson<T>(contents?: T): NdjsonFile<T>;
+    ndjson<T>(lines?: T | T[]): NdjsonFile<T>;
     static get ndjson(): typeof NdjsonFile;
 }
 declare class FileAdaptor<T = string> {
@@ -24,6 +25,7 @@ declare class FileAdaptor<T = string> {
     constructor(filepath: string, contents?: T);
     get exists(): boolean;
     get path(): string;
+    delete(): void;
 }
 declare class JsonFile<T> extends FileAdaptor {
     constructor(filepath: string, contents?: T);
@@ -31,7 +33,7 @@ declare class JsonFile<T> extends FileAdaptor {
     write(contents: T): void;
 }
 declare class NdjsonFile<T> extends FileAdaptor {
-    constructor(filepath: string, contents?: T);
+    constructor(filepath: string, lines?: T | T[]);
     append(lines: T | T[]): void;
     lines(): T[];
 }

package/dist/File.js

@@ -33,6 +33,9 @@ export class File {
         const contents = (this.read() || '').split('\n');
         return contents.slice(0, contents.length - 1);
     }
+    delete() {
+        fs.rmSync(this.path, { force: true });
+    }
     static get Adaptor() {
         return FileAdaptor;
     }
@@ -42,8 +45,8 @@ export class File {
     static get json() {
         return JsonFile;
     }
-    ndjson(contents) {
-        return new NdjsonFile(this.path, contents);
+    ndjson(lines) {
+        return new NdjsonFile(this.path, lines);
     }
     static get ndjson() {
         return NdjsonFile;
@@ -66,6 +69,9 @@ class FileAdaptor {
     get path() {
         return this.file.path;
     }
+    delete() {
+        this.file.delete();
+    }
 }
 class JsonFile extends FileAdaptor {
     constructor(filepath, contents) {
@@ -82,10 +88,10 @@ class JsonFile extends FileAdaptor {
     }
 }
 class NdjsonFile extends FileAdaptor {
-    constructor(filepath, contents) {
+    constructor(filepath, lines) {
         super(filepath.endsWith('.ndjson') ? filepath : filepath + '.ndjson');
-        if (contents)
-            this.append(contents);
+        if (lines)
+            this.append(lines);
     }
     append(lines) {
         this.file.append(Array.isArray(lines) ? lines.map((l) => JSON.stringify(snapshot(l))) : JSON.stringify(snapshot(lines)));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brianbuie/node-kit",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "license": "ISC",
   "repository": {
     "type": "git",

package/src/File.test.ts

@@ -15,7 +15,7 @@ const thing = {
 };
 
 describe('FileAdaptor', () => {
-  it('Instances can be created', () => {
+  it('Creates instances', () => {
     const test1 = new File.Adaptor(testDir.filepath('test1.txt'));
     assert(test1.file.path.includes('test1.txt'));
 
@@ -26,6 +26,14 @@ describe('FileAdaptor', () => {
     const eg3 = eg3File.json();
     assert(eg1.path === eg2.path && eg2.path === eg3.path);
   });
+
+  it('Deletes files', () => {
+    const test = testDir.file('delete-test.txt');
+    test.write('test');
+    assert.equal(test.read(), 'test');
+    test.delete();
+    assert.equal(test.exists, false);
+  });
 });
 
 describe('File.ndjson', () => {

package/src/File.ts

@@ -40,6 +40,10 @@ export class File {
     return contents.slice(0, contents.length - 1);
   }
 
+  delete() {
+    fs.rmSync(this.path, { force: true });
+  }
+
   static get Adaptor() {
     return FileAdaptor;
   }
@@ -52,8 +56,8 @@ export class File {
     return JsonFile;
   }
 
-  ndjson<T>(contents?: T) {
-    return new NdjsonFile<T>(this.path, contents);
+  ndjson<T>(lines?: T | T[]) {
+    return new NdjsonFile<T>(this.path, lines);
   }
 
   static get ndjson() {
@@ -81,6 +85,10 @@ class FileAdaptor<T = string> {
   get path() {
     return this.file.path;
   }
+
+  delete() {
+    this.file.delete();
+  }
 }
 
 class JsonFile<T> extends FileAdaptor {
@@ -100,9 +108,9 @@ class JsonFile<T> extends FileAdaptor {
 }
 
 class NdjsonFile<T> extends FileAdaptor {
-  constructor(filepath: string, contents?: T) {
+  constructor(filepath: string, lines?: T | T[]) {
     super(filepath.endsWith('.ndjson') ? filepath : filepath + '.ndjson');
-    if (contents) this.append(contents);
+    if (lines) this.append(lines);
   }
 
   append(lines: T | T[]) {