@file-services/types - npm Package Compare versions

Comparing version 5.7.1 to 6.0.0

dist/base-api-async.d.ts

@@ -1,2 +0,2 @@
-import type { IFileSystemStats, BufferEncoding, CallbackFnVoid, CallbackFn, WriteFileOptions, ReadFileOptions, IDirectoryEntry } from './common-fs-types.js';
+import type { IFileSystemStats, BufferEncoding, CallbackFnVoid, CallbackFn, WriteFileOptions, ReadFileOptions, IDirectoryEntry, RmOptions } from './common-fs-types.js';
 import type { IFileSystemPath } from './path.js';
@@ -177,3 +177,7 @@ import type { IWatchService } from './watch-api.js';
     symlink(target: string, path: string, type?: 'dir' | 'file' | 'junction'): Promise<void>;
+    /**
+     * Removes files and directories.
+     */
+    rm(path: string, options?: RmOptions): Promise<void>;
 }
 //# sourceMappingURL=base-api-async.d.ts.map

dist/base-api-sync.d.ts

@@ -1,2 +0,2 @@
-import type { IFileSystemStats, BufferEncoding, WriteFileOptions, ReadFileOptions, IDirectoryEntry, StatSyncOptions } from './common-fs-types.js';
+import type { IFileSystemStats, BufferEncoding, WriteFileOptions, ReadFileOptions, IDirectoryEntry, StatSyncOptions, RmOptions } from './common-fs-types.js';
 import type { IFileSystemPath } from './path.js';
@@ -118,3 +118,7 @@ import type { IWatchService } from './watch-api.js';
     symlinkSync(target: string, path: string, type?: 'dir' | 'file' | 'junction'): void;
+    /**
+     * Removes files and directories.
+     */
+    rmSync(path: string, options?: RmOptions): void;
 }
 //# sourceMappingURL=base-api-sync.d.ts.map

dist/base-api.js

 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
@@ -6,0 +10,0 @@ if (k2 === undefined) k2 = k;

dist/common-fs-types.d.ts

@@ -120,2 +120,14 @@ export declare type BufferEncoding = 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'latin1' | 'binary' | 'hex';
 }
+export interface RmOptions {
+    /**
+     * When `true`, exceptions will be ignored if `path` does not exist.
+     * @default false
+     */
+    force?: boolean | undefined;
+    /**
+     * If `true`, perform a recursive directory removal.
+     * @default false
+     */
+    recursive?: boolean | undefined;
+}
 //# sourceMappingURL=common-fs-types.d.ts.map

dist/extended-api-async.d.ts

@@ -58,6 +58,2 @@ import type { IDirectoryContents, IWalkOptions, BufferEncoding } from './common-fs-types.js';
     /**
-     * Recursively remove a path.
-     */
-    remove(path: string): Promise<void>;
-    /**
      * Read a file and parse it using `JSON.parse`.
@@ -64,0 +60,0 @@ *

dist/extended-api-sync.d.ts

@@ -55,6 +55,2 @@ import type { IWalkOptions, IDirectoryContents, BufferEncoding } from './common-fs-types.js';
     /**
-     * Recursively remove a path.
-     */
-    removeSync(path: string): void;
-    /**
      * Read a file and parse it using `JSON.parse`.
@@ -61,0 +57,0 @@ *

dist/extended-api.js

 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
@@ -6,0 +10,0 @@ if (k2 === undefined) k2 = k;

dist/index.js

 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
@@ -6,0 +10,0 @@ if (k2 === undefined) k2 = k;

package.json

 {
   "name": "@file-services/types",
   "description": "Common file system interfaces",
-  "version": "5.7.1",
+  "version": "6.0.0",
   "main": "dist/index.js",
@@ -6,0 +6,0 @@ "files": [

src/base-api-async.ts

@@ -9,2 +9,3 @@ import type {
   IDirectoryEntry,
+  RmOptions,
 } from './common-fs-types.js';
@@ -204,2 +205,7 @@ import type { IFileSystemPath } from './path.js';
   symlink(target: string, path: string, type?: 'dir' | 'file' | 'junction'): Promise<void>;
+
+  /**
+   * Removes files and directories.
+   */
+  rm(path: string, options?: RmOptions): Promise<void>;
 }

src/base-api-sync.ts

@@ -8,2 +8,3 @@ import type {
   StatSyncOptions,
+  RmOptions,
 } from './common-fs-types.js';
@@ -125,2 +126,7 @@ import type { IFileSystemPath } from './path.js';
   symlinkSync(target: string, path: string, type?: 'dir' | 'file' | 'junction'): void;
+
+  /**
+   * Removes files and directories.
+   */
+  rmSync(path: string, options?: RmOptions): void;
 }

src/common-fs-types.ts

@@ -158,1 +158,15 @@ export type BufferEncoding =
 }
+
+export interface RmOptions {
+  /**
+   * When `true`, exceptions will be ignored if `path` does not exist.
+   * @default false
+   */
+  force?: boolean | undefined;
+
+  /**
+   * If `true`, perform a recursive directory removal.
+   * @default false
+   */
+  recursive?: boolean | undefined;
+}

src/extended-api-async.ts

@@ -67,7 +67,2 @@ import type { IDirectoryContents, IWalkOptions, BufferEncoding } from './common-fs-types.js';
   /**
-   * Recursively remove a path.
-   */
-  remove(path: string): Promise<void>;
-
-  /**
    * Read a file and parse it using `JSON.parse`.
@@ -74,0 +69,0 @@ *

src/extended-api-sync.ts

@@ -63,7 +63,2 @@ import type { IWalkOptions, IDirectoryContents, BufferEncoding } from './common-fs-types.js';
   /**
-   * Recursively remove a path.
-   */
-  removeSync(path: string): void;
-
-  /**
    * Read a file and parse it using `JSON.parse`.
@@ -70,0 +65,0 @@ *

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

77329

increased by1.9%

Lines of code

1657

increased by2.35%

No dependency changes