@file-services/types - npm Package Compare versions

Comparing version 0.4.7 to 0.4.8

cjs/base-api.d.ts

@@ -5,4 +5,4 @@ /// <reference types="node" />
 /**
- * SYNC and ASYNC file system containing
- * Contains a subset of `fs`, watch service, and path methods
+ * SYNC and ASYNC base file system.
+ * Contains a subset of `fs`, watch service, and path methods.
  */
@@ -12,4 +12,4 @@ export interface IBaseFileSystem extends IBaseFileSystemAsync, IBaseFileSystemSync {
 /**
- * SYNC-only, base file system
- * Contains a subset of `fs`, watch service, and path methods
+ * SYNC-only base file system.
+ * Contains a subset of `fs`, watch service, and path methods.
  */
@@ -21,7 +21,8 @@ export interface IBaseFileSystemSync {
     /**
-     * Synchronously copies src to dest.
-     * Param flags is used as modifiers for copy operation. Default: 0 (dest is overwritten if it already exists)
-     * flags = FileSystemConstants.COPYFILE_EXCL will cause copy operation to fail if dest already exists.
+     * Copy `sourcePath` to `destinationPath`.
+     * By default, if destination already exists, it will be overwritten.
+     *
+     * @param flags passing `FileSystemConstants.COPYFILE_EXCL` will cause operation to fail if destination exists.
      */
-    copyFileSync(src: string, dest: string, flags?: number): void;
+    copyFileSync(sourcePath: string, destinationPath: string, flags?: number): void;
     /**
@@ -76,4 +77,4 @@ * Read the entire contents of a file as a string.
 /**
- * ASYNC-only, base file system
- * Contains a subset of `fs`, watch service, and path methods
+ * ASYNC-only base file system.
+ * Contains a subset of `fs`, watch service, and path methods.
  */
@@ -85,7 +86,8 @@ export interface IBaseFileSystemAsync {
     /**
-     * Asynchronously copies src to dest.
-     * Param flags is used as modifiers for copy operation. Default: 0 (dest is overwritten if it already exists)
-     * flags = FileSystemConstants.COPYFILE_EXCL will cause copy operation to fail if dest already exists.
+     * Copy `sourcePath` to `destinationPath`.
+     * By default, if destination already exists, it will be overwritten.
+     *
+     * @param flags passing `FileSystemConstants.COPYFILE_EXCL` will cause operation to fail if destination exists.
      */
-    copyFile(src: string, dest: string, flags?: number): Promise<void>;
+    copyFile(sourcePath: string, destinationPath: string, flags?: number): Promise<void>;
     /**
@@ -92,0 +94,0 @@ * Read the entire contents of a file as a string.

cjs/constants.d.ts

 export declare enum FileSystemConstants {
     /**
-     * Used is fs.copyFile flags param, causes copy operation to fail if dest already exists.
+     * When passed as a flag to `copyFile` or `copyFileSync`,
+     * causes operation to fail if destination already exists.
      */
@@ -5,0 +6,0 @@ COPYFILE_EXCL = 1

cjs/constants.js

@@ -6,3 +6,4 @@ "use strict";
     /**
-     * Used is fs.copyFile flags param, causes copy operation to fail if dest already exists.
+     * When passed as a flag to `copyFile` or `copyFileSync`,
+     * causes operation to fail if destination already exists.
      */
@@ -9,0 +10,0 @@ FileSystemConstants[FileSystemConstants["COPYFILE_EXCL"] = 1] = "COPYFILE_EXCL";

cjs/extended-api.d.ts

 import { IBaseFileSystemAsync, IBaseFileSystemSync, IFileSystemStats } from './base-api';
 /**
- * SYNC and ASYNC file system containing
- * Contains all base apis, and adds higher level apis
+ * SYNC and ASYNC file system.
+ * Exposes all base fs APIs plus several higher level methods.
  */
@@ -9,4 +9,4 @@ export interface IFileSystem extends IFileSystemAsync, IFileSystemSync {
 /**
- * SYNC-only file system containing
- * Contains all base apis, and adds higher level apis
+ * SYNC-only file system.
+ * Exposes all base fs APIs plus several higher level methods.
  */
@@ -46,4 +46,4 @@ export interface IFileSystemSync extends IBaseFileSystemSync {
 /**
- * ASYNC-only file system containing
- * Contains all base apis, and adds higher level apis
+ * ASYNC-only file system.
+ * Exposes all base fs APIs plus several higher level methods.
  */
@@ -50,0 +50,0 @@ export interface IFileSystemAsync extends IBaseFileSystemAsync {

cjs/index.d.ts

 export * from './base-api';
+export * from './constants';
 export * from './extended-api';
 export * from './path';
 export * from './watch-api';
-export * from './constants';
 //# sourceMappingURL=index.d.ts.map

package.json

 {
   "name": "@file-services/types",
   "description": "Common file system interfaces",
-  "version": "0.4.7",
+  "version": "0.4.8",
   "main": "cjs/index.js",
@@ -15,3 +15,4 @@ "types": "cjs/index.d.ts",
     "cjs",
-    "src/**/*.ts"
+    "src",
+    "!src/tsconfig.json"
   ],
@@ -25,3 +26,3 @@ "license": "MIT",
   "sideEffects": false,
-  "gitHead": "801ee42213735758dfacaedcf14537635f89e3d0"
+  "gitHead": "8d71dfadccd2534c01ad1d3f332915693967e957"
 }

src/base-api.ts

@@ -5,4 +5,4 @@ import { IWatchService } from './watch-api'
 /**
- * SYNC and ASYNC file system containing
- * Contains a subset of `fs`, watch service, and path methods
+ * SYNC and ASYNC base file system.
+ * Contains a subset of `fs`, watch service, and path methods.
  */
@@ -12,4 +12,4 @@ export interface IBaseFileSystem extends IBaseFileSystemAsync, IBaseFileSystemSync { }
 /**
- * SYNC-only, base file system
- * Contains a subset of `fs`, watch service, and path methods
+ * SYNC-only base file system.
+ * Contains a subset of `fs`, watch service, and path methods.
  */
@@ -22,7 +22,8 @@ export interface IBaseFileSystemSync {
     /**
-     * Synchronously copies src to dest.
-     * Param flags is used as modifiers for copy operation. Default: 0 (dest is overwritten if it already exists)
-     * flags = FileSystemConstants.COPYFILE_EXCL will cause copy operation to fail if dest already exists.
+     * Copy `sourcePath` to `destinationPath`.
+     * By default, if destination already exists, it will be overwritten.
+     *
+     * @param flags passing `FileSystemConstants.COPYFILE_EXCL` will cause operation to fail if destination exists.
      */
-    copyFileSync(src: string, dest: string, flags?: number): void
+    copyFileSync(sourcePath: string, destinationPath: string, flags?: number): void
 
@@ -89,4 +90,4 @@ /**
 /**
- * ASYNC-only, base file system
- * Contains a subset of `fs`, watch service, and path methods
+ * ASYNC-only base file system.
+ * Contains a subset of `fs`, watch service, and path methods.
  */
@@ -99,7 +100,8 @@ export interface IBaseFileSystemAsync {
     /**
-     * Asynchronously copies src to dest.
-     * Param flags is used as modifiers for copy operation. Default: 0 (dest is overwritten if it already exists)
-     * flags = FileSystemConstants.COPYFILE_EXCL will cause copy operation to fail if dest already exists.
+     * Copy `sourcePath` to `destinationPath`.
+     * By default, if destination already exists, it will be overwritten.
+     *
+     * @param flags passing `FileSystemConstants.COPYFILE_EXCL` will cause operation to fail if destination exists.
      */
-    copyFile(src: string, dest: string, flags?: number): Promise<void>
+    copyFile(sourcePath: string, destinationPath: string, flags?: number): Promise<void>
 
@@ -106,0 +108,0 @@ /**

src/constants.ts

 export enum FileSystemConstants {
     /**
-     * Used is fs.copyFile flags param, causes copy operation to fail if dest already exists.
+     * When passed as a flag to `copyFile` or `copyFileSync`,
+     * causes operation to fail if destination already exists.
      */
     COPYFILE_EXCL = 1
 }

src/extended-api.ts

 import { IBaseFileSystemAsync, IBaseFileSystemSync, IFileSystemStats } from './base-api'
 
 /**
- * SYNC and ASYNC file system containing
- * Contains all base apis, and adds higher level apis
+ * SYNC and ASYNC file system.
+ * Exposes all base fs APIs plus several higher level methods.
  */
@@ -10,4 +10,4 @@ export interface IFileSystem extends IFileSystemAsync, IFileSystemSync { }
 /**
- * SYNC-only file system containing
- * Contains all base apis, and adds higher level apis
+ * SYNC-only file system.
+ * Exposes all base fs APIs plus several higher level methods.
  */
@@ -59,4 +59,4 @@ export interface IFileSystemSync extends IBaseFileSystemSync {
 /**
- * ASYNC-only file system containing
- * Contains all base apis, and adds higher level apis
+ * ASYNC-only file system.
+ * Exposes all base fs APIs plus several higher level methods.
  */
@@ -63,0 +63,0 @@ export interface IFileSystemAsync extends IBaseFileSystemAsync {

src/index.ts

 export * from './base-api'
+export * from './constants'
 export * from './extended-api'
 export * from './path'
 export * from './watch-api'
-export * from './constants'

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

37915

increased by0.27%

Lines of code

853

increased by0.83%

No dependency changes