@microsoft/node-core-library - npm Package Compare versions

Comparing version 2.2.1 to 3.0.0

CHANGELOG.json

@@ -5,2 +5,14 @@ {
     {
+      "version": "3.0.0",
+      "tag": "@microsoft/node-core-library_v3.0.0",
+      "date": "Wed, 29 Aug 2018 06:36:50 GMT",
+      "comments": {
+        "major": [
+          {
+            "comment": "(Breaking API change) The FileSystem move/copy/createLink operations now require the source/target parameters to be explicitly specified, to avoid confusion"
+          }
+        ]
+      }
+    },
+    {
       "version": "2.2.1",
@@ -7,0 +19,0 @@ "tag": "@microsoft/node-core-library_v2.2.1",

CHANGELOG.md

 # Change Log - @microsoft/node-core-library
 
-This log was last generated on Thu, 23 Aug 2018 18:18:53 GMT and should not be manually modified.
+This log was last generated on Wed, 29 Aug 2018 06:36:50 GMT and should not be manually modified.
 
+## 3.0.0
+Wed, 29 Aug 2018 06:36:50 GMT
+
+### Breaking changes
+
+- (Breaking API change) The FileSystem move/copy/createLink operations now require the source/target parameters to be explicitly specified, to avoid confusion
+
 ## 2.2.1
@@ -6,0 +13,0 @@ Thu, 23 Aug 2018 18:18:53 GMT

dist/index-internal.d.ts

@@ -195,3 +195,3 @@ /**
  * Note that in the documentation, we refer to "filesystem objects", this can be a
- * file, folder, synbolic link, hard link, directory junction, etc.
+ * file, folder, symbolic link, hard link, directory junction, etc.
  *
@@ -227,3 +227,3 @@ * @public
      */
-    static updateTimes(path: string, times: IUpdateTimeParameters): void;
+    static updateTimes(path: string, times: IFileSystemUpdateTimeParameters): void;
     /**
@@ -253,7 +253,4 @@ * Changes the permissions (i.e. file mode bits) for a filesystem object.
      * Behind the scenes it uses `fs-extra.moveSync()`
-     * @param sourcePath - The absolute or relative path to the source file.
-     * @param targetPath - The absolute or relative path where the file should be moved to.
-     * @param options - Optional settings that can change the behavior. Type: `IFileSystemMoveOptions`
      */
-    static move(sourcePath: string, targetPath: string, options?: IFileSystemMoveOptions): void;
+    static move(options: IFileSystemMoveOptions): void;
     /**
@@ -273,3 +270,3 @@ * Recursively creates a folder at a given path.
      */
-    static readFolder(folderPath: string, options?: IReadFolderOptions): Array<string>;
+    static readFolder(folderPath: string, options?: IFileSystemReadFolderOptions): Array<string>;
     /**
@@ -301,3 +298,3 @@ * Deletes a folder, including all of its contents.
      */
-    static writeFile(filePath: string, contents: string | Buffer, options?: IWriteFileOptions): void;
+    static writeFile(filePath: string, contents: string | Buffer, options?: IFileSystemWriteFileOptions): void;
     /**
@@ -309,3 +306,3 @@ * Reads the contents of a file into a string.
      */
-    static readFile(filePath: string, options?: IReadFileOptions): string;
+    static readFile(filePath: string, options?: IFileSystemReadFileOptions): string;
     /**
@@ -321,6 +318,4 @@ * Reads the contents of a file into a buffer.
      * Behind the scenes it uses `fs.copyFileSync()`.
-     * @param sourcePath - The absolute or relative path to the source file to be copied.
-     * @param destinationPath - The absolute or relative path to the new copy that will be created.
      */
-    static copyFile(sourcePath: string, destinationPath: string): void;
+    static copyFile(options: IFileSystemCopyFileOptions): void;
     /**
@@ -332,3 +327,3 @@ * Deletes a file. Can optionally throw if the file doesn't exist.
      */
-    static deleteFile(filePath: string, options?: IDeleteFileOptions): void;
+    static deleteFile(filePath: string, options?: IFileSystemDeleteFileOptions): void;
     /**
@@ -343,27 +338,19 @@ * Gets the statistics of a filesystem object. Does NOT follow the link to its target.
      * Behind the scenes it uses `fs.symlinkSync()`.
-     * @param linkSource - The absolute or relative path to the destination where the link should be created.
-     * @param linkTarget - The absolute or relative path to the target of the link.
      */
-    static createSymbolicLinkJunction(linkTarget: string, linkSource: string): void;
+    static createSymbolicLinkJunction(options: IFileSystemCreateLinkOptions): void;
     /**
      * Creates a symbolic link to a file (on Windows this requires elevated permissionsBits).
      * Behind the scenes it uses `fs.symlinkSync()`.
-     * @param linkSource - The absolute or relative path to the destination where the link should be created.
-     * @param linkTarget - The absolute or relative path to the target of the link.
      */
-    static createSymbolicLinkFile(linkTarget: string, linkSource: string): void;
+    static createSymbolicLinkFile(options: IFileSystemCreateLinkOptions): void;
     /**
      * Creates a symbolic link to a folder (on Windows this requires elevated permissionsBits).
      * Behind the scenes it uses `fs.symlinkSync()`.
-     * @param linkSource - The absolute or relative path to the destination where the link should be created.
-     * @param linkTarget - The absolute or relative path to the target of the link.
      */
-    static createSymbolicLinkFolder(linkTarget: string, linkSource: string): void;
+    static createSymbolicLinkFolder(options: IFileSystemCreateLinkOptions): void;
     /**
      * Creates a hard link.
      * Behind the scenes it uses `fs.linkSync()`.
-     * @param linkSource - The absolute or relative path to the destination where the link should be created.
-     * @param linkTarget - The absolute or relative path to the target of the link.
      */
-    static createHardLink(linkTarget: string, linkSource: string): void;
+    static createHardLink(options: IFileSystemCreateLinkOptions): void;
     /**
@@ -434,14 +421,2 @@ * Follows a link to its destination and returns the absolute path to the final target of the link.
 /**
- * The options for FileSystem.deleteFile()
- * @public
-*/
-export declare interface IDeleteFileOptions {
-    /**
-     * If true, will throw an exception if the file did not exist before `deleteFile()` was called.
-     * Defaults to `false`.
-     */
-    throwIfNotExists?: boolean;
-}
-
-/**
  * Options for Executable.tryResolve().
@@ -492,2 +467,48 @@ * @beta
 /**
+ * The options for FileSystem.copyFile()
+ * @public
+ */
+export declare interface IFileSystemCopyFileOptions {
+    /**
+     * The path of the existing object to be copied.
+     * The path may be absolute or relative.
+     */
+    sourcePath: string;
+    /**
+     * The path that the object will be copied to.
+     * The path may be absolute or relative.
+     */
+    destinationPath: string;
+}
+
+/**
+ * The options for `FileSystem.createSymbolicLinkJunction()`, `createSymbolicLinkFile()`,
+ * `createSymbolicLinkFolder()`,  and `createHardLink()`.
+ *
+ * @public
+ */
+export declare interface IFileSystemCreateLinkOptions {
+    /**
+     * The existing path that the symbolic link will point to.
+     */
+    linkTargetPath: string;
+    /**
+     * The new path for the new symlink link to be created.
+     */
+    newLinkPath: string;
+}
+
+/**
+ * The options for FileSystem.deleteFile()
+ * @public
+*/
+export declare interface IFileSystemDeleteFileOptions {
+    /**
+     * If true, will throw an exception if the file did not exist before `deleteFile()` was called.
+     * Defaults to `false`.
+     */
+    throwIfNotExists?: boolean;
+}
+
+/**
  * The options for FileSystem.move()
@@ -498,2 +519,12 @@ * @public
     /**
+     * The path of the existing object to be moved.
+     * The path may be absolute or relative.
+     */
+    sourcePath: string;
+    /**
+     * The new path for the object.
+     * The path may be absolute or relative.
+     */
+    destinationPath: string;
+    /**
      * If true, will overwrite the file if it already exists. Defaults to true.
@@ -510,2 +541,69 @@ */
 /**
+ * The options for FileSystem.readFile()
+ * @public
+ */
+export declare interface IFileSystemReadFileOptions {
+    /**
+     * If specified, will change the encoding of the file that will be written.
+     * Defaults to `"utf8"`.
+     */
+    encoding?: Encoding;
+    /**
+     * If specified, will normalize line endings to the specified style of newline.
+     * Defaults to `NewlineKind.None`.
+     */
+    convertLineEndings?: NewlineKind;
+}
+
+/**
+ * The options for FileSystem.readFolder()
+ * @public
+ */
+export declare interface IFileSystemReadFolderOptions {
+    /**
+     * If true, returns the absolute paths of the files in the folder.
+     * Defaults to `false`.
+     */
+    absolutePaths?: boolean;
+}
+
+/**
+ * The parameters for `updateTimes()`.
+ * Both times must be specified.
+ * @public
+ */
+export declare interface IFileSystemUpdateTimeParameters {
+    /**
+     * The POSIX epoch time or Date when this was last accessed.
+     */
+    accessedTime: number | Date;
+    /**
+     * The POSIX epoch time or Date when this was last modified
+     */
+    modifiedTime: number | Date;
+}
+
+/**
+ * The options for FileSystem.writeFile()
+ * @public
+ */
+export declare interface IFileSystemWriteFileOptions {
+    /**
+     * If true, will ensure the folder is created before writing the file.
+     * Defaults to `false`.
+     */
+    ensureFolderExists?: boolean;
+    /**
+     * If specified, will normalize line endings to the specified style of newline.
+     * Defaults to `NewlineKind.None`.
+     */
+    convertLineEndings?: NewlineKind;
+    /**
+     * If specified, will change the encoding of the file that will be written.
+     * Defaults to `"utf8"`.
+     */
+    encoding?: Encoding;
+}
+
+/**
  * Interface which represents the flags about which mode the file should be opened in.
@@ -815,69 +913,2 @@ * @public
 /**
- * The options for FileSystem.readFile()
- * @public
- */
-export declare interface IReadFileOptions {
-    /**
-     * If specified, will change the encoding of the file that will be written.
-     * Defaults to `"utf8"`.
-     */
-    encoding?: Encoding;
-    /**
-     * If specified, will normalize line endings to the specified style of newline.
-     * Defaults to `NewlineKind.None`.
-     */
-    convertLineEndings?: NewlineKind;
-}
-
-/**
- * The options for FileSystem.readFolder()
- * @public
- */
-export declare interface IReadFolderOptions {
-    /**
-     * If true, returns the absolute paths of the files in the folder.
-     * Defaults to `false`.
-     */
-    absolutePaths?: boolean;
-}
-
-/**
- * The parameters for `updateTimes()`.
- * Both times must be specified.
- * @public
- */
-export declare interface IUpdateTimeParameters {
-    /**
-     * The POSIX epoch time or Date when this was last accessed.
-     */
-    accessedTime: number | Date;
-    /**
-     * The POSIX epoch time or Date when this was last modified
-     */
-    modifiedTime: number | Date;
-}
-
-/**
- * The options for FileSystem.writeFile()
- * @public
- */
-export declare interface IWriteFileOptions {
-    /**
-     * If true, will ensure the folder is created before writing the file.
-     * Defaults to `false`.
-     */
-    ensureFolderExists?: boolean;
-    /**
-     * If specified, will normalize line endings to the specified style of newline.
-     * Defaults to `NewlineKind.None`.
-     */
-    convertLineEndings?: NewlineKind;
-    /**
-     * If specified, will change the encoding of the file that will be written.
-     * Defaults to `"utf8"`.
-     */
-    encoding?: Encoding;
-}
-
-/**
  * Utilities for reading/writing JSON files.
@@ -884,0 +915,0 @@ * @public

lib/FileDiffTest.js

@@ -66,3 +66,6 @@ "use strict";
             }
-            FileSystem_1.FileSystem.copyFile(expectedFilePath, expectedCopyFilename);
+            FileSystem_1.FileSystem.copyFile({
+                sourcePath: expectedFilePath,
+                destinationPath: expectedCopyFilename
+            });
             // Set to read-only so that developer doesn't accidentally modify the wrong file
@@ -69,0 +72,0 @@ FileSystem_1.FileSystem.changePosixModeBits(expectedCopyFilename, 292 /* AllRead */);

lib/FileSystem.d.ts

 /// <reference types="node" />
 import * as fs from 'fs';
-import { NewlineKind } from './Text';
+import { NewlineKind, Encoding } from './Text';
+import { PosixModeBits } from './PosixModeBits';
 /**
- * The allowed types of encodings, as supported by Node.js
- * @public
- */
-export declare const enum Encoding {
-    Utf8 = "utf8",
-}
-/**
- * An integer value used to specify file permissions for POSIX-like operating systems.
- *
- * @remarks
- *
- * This bitfield corresponds to the "mode_t" structure described in this document:
- * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_stat.h.html
- *
- * It is used with NodeJS APIs such as fs.Stat.mode and fs.chmodSync().  These values
- * represent a set of permissions and can be combined using bitwise arithmetic.
- *
- * POSIX is a registered trademark of the Institute of Electrical and Electronic Engineers, Inc.
- *
- * @public
- */
-export declare const enum PosixModeBits {
-    /**
-     * Indicates that the item's owner can read the item.
-     */
-    UserRead = 256,
-    /**
-     * Indicates that the item's owner can modify the item.
-     */
-    UserWrite = 128,
-    /**
-     * Indicates that the item's owner can execute the item (if it is a file)
-     * or search the item (if it is a directory).
-     */
-    UserExecute = 64,
-    /**
-     * Indicates that users belonging to the item's group can read the item.
-     */
-    GroupRead = 32,
-    /**
-     * Indicates that users belonging to the item's group can modify the item.
-     */
-    GroupWrite = 16,
-    /**
-     * Indicates that users belonging to the item's group can execute the item (if it is a file)
-     * or search the item (if it is a directory).
-     */
-    GroupExecute = 8,
-    /**
-     * Indicates that other users (besides the item's owner user or group) can read the item.
-     */
-    OthersRead = 4,
-    /**
-     * Indicates that other users (besides the item's owner user or group) can modify the item.
-     */
-    OthersWrite = 2,
-    /**
-     * Indicates that other users (besides the item's owner user or group) can execute the item (if it is a file)
-     * or search the item (if it is a directory).
-     */
-    OthersExecute = 1,
-    /**
-     * A zero value where no permissions bits are set.
-     */
-    None = 0,
-    /**
-     * An alias combining OthersRead, GroupRead, and UserRead permission bits.
-     */
-    AllRead = 292,
-    /**
-     * An alias combining OthersWrite, GroupWrite, and UserWrite permission bits.
-     */
-    AllWrite = 146,
-    /**
-     * An alias combining OthersExecute, GroupExecute, and UserExecute permission bits.
-     */
-    AllExecute = 73,
-}
-/**
  * The options for FileSystem.readFolder()
  * @public
  */
-export interface IReadFolderOptions {
+export interface IFileSystemReadFolderOptions {
     /**
@@ -98,3 +20,3 @@ * If true, returns the absolute paths of the files in the folder.
  */
-export interface IWriteFileOptions {
+export interface IFileSystemWriteFileOptions {
     /**
@@ -120,3 +42,3 @@ * If true, will ensure the folder is created before writing the file.
  */
-export interface IReadFileOptions {
+export interface IFileSystemReadFileOptions {
     /**
@@ -139,2 +61,12 @@ * If specified, will change the encoding of the file that will be written.
     /**
+     * The path of the existing object to be moved.
+     * The path may be absolute or relative.
+     */
+    sourcePath: string;
+    /**
+     * The new path for the object.
+     * The path may be absolute or relative.
+     */
+    destinationPath: string;
+    /**
      * If true, will overwrite the file if it already exists. Defaults to true.
@@ -150,6 +82,22 @@ */
 /**
+ * The options for FileSystem.copyFile()
+ * @public
+ */
+export interface IFileSystemCopyFileOptions {
+    /**
+     * The path of the existing object to be copied.
+     * The path may be absolute or relative.
+     */
+    sourcePath: string;
+    /**
+     * The path that the object will be copied to.
+     * The path may be absolute or relative.
+     */
+    destinationPath: string;
+}
+/**
  * The options for FileSystem.deleteFile()
  * @public
 */
-export interface IDeleteFileOptions {
+export interface IFileSystemDeleteFileOptions {
     /**
@@ -166,3 +114,3 @@ * If true, will throw an exception if the file did not exist before `deleteFile()` was called.
  */
-export interface IUpdateTimeParameters {
+export interface IFileSystemUpdateTimeParameters {
     /**
@@ -178,2 +126,18 @@ * The POSIX epoch time or Date when this was last accessed.
 /**
+ * The options for `FileSystem.createSymbolicLinkJunction()`, `createSymbolicLinkFile()`,
+ * `createSymbolicLinkFolder()`,  and `createHardLink()`.
+ *
+ * @public
+ */
+export interface IFileSystemCreateLinkOptions {
+    /**
+     * The existing path that the symbolic link will point to.
+     */
+    linkTargetPath: string;
+    /**
+     * The new path for the new symlink link to be created.
+     */
+    newLinkPath: string;
+}
+/**
  * The FileSystem API provides a complete set of recommended operations for interacting with the file system.
@@ -190,3 +154,3 @@ *
  * Note that in the documentation, we refer to "filesystem objects", this can be a
- * file, folder, synbolic link, hard link, directory junction, etc.
+ * file, folder, symbolic link, hard link, directory junction, etc.
  *
@@ -222,3 +186,3 @@ * @public
      */
-    static updateTimes(path: string, times: IUpdateTimeParameters): void;
+    static updateTimes(path: string, times: IFileSystemUpdateTimeParameters): void;
     /**
@@ -248,7 +212,4 @@ * Changes the permissions (i.e. file mode bits) for a filesystem object.
      * Behind the scenes it uses `fs-extra.moveSync()`
-     * @param sourcePath - The absolute or relative path to the source file.
-     * @param targetPath - The absolute or relative path where the file should be moved to.
-     * @param options - Optional settings that can change the behavior. Type: `IFileSystemMoveOptions`
      */
-    static move(sourcePath: string, targetPath: string, options?: IFileSystemMoveOptions): void;
+    static move(options: IFileSystemMoveOptions): void;
     /**
@@ -268,3 +229,3 @@ * Recursively creates a folder at a given path.
      */
-    static readFolder(folderPath: string, options?: IReadFolderOptions): Array<string>;
+    static readFolder(folderPath: string, options?: IFileSystemReadFolderOptions): Array<string>;
     /**
@@ -296,3 +257,3 @@ * Deletes a folder, including all of its contents.
      */
-    static writeFile(filePath: string, contents: string | Buffer, options?: IWriteFileOptions): void;
+    static writeFile(filePath: string, contents: string | Buffer, options?: IFileSystemWriteFileOptions): void;
     /**
@@ -304,3 +265,3 @@ * Reads the contents of a file into a string.
      */
-    static readFile(filePath: string, options?: IReadFileOptions): string;
+    static readFile(filePath: string, options?: IFileSystemReadFileOptions): string;
     /**
@@ -316,6 +277,4 @@ * Reads the contents of a file into a buffer.
      * Behind the scenes it uses `fs.copyFileSync()`.
-     * @param sourcePath - The absolute or relative path to the source file to be copied.
-     * @param destinationPath - The absolute or relative path to the new copy that will be created.
      */
-    static copyFile(sourcePath: string, destinationPath: string): void;
+    static copyFile(options: IFileSystemCopyFileOptions): void;
     /**
@@ -327,3 +286,3 @@ * Deletes a file. Can optionally throw if the file doesn't exist.
      */
-    static deleteFile(filePath: string, options?: IDeleteFileOptions): void;
+    static deleteFile(filePath: string, options?: IFileSystemDeleteFileOptions): void;
     /**
@@ -338,27 +297,19 @@ * Gets the statistics of a filesystem object. Does NOT follow the link to its target.
      * Behind the scenes it uses `fs.symlinkSync()`.
-     * @param linkSource - The absolute or relative path to the destination where the link should be created.
-     * @param linkTarget - The absolute or relative path to the target of the link.
      */
-    static createSymbolicLinkJunction(linkTarget: string, linkSource: string): void;
+    static createSymbolicLinkJunction(options: IFileSystemCreateLinkOptions): void;
     /**
      * Creates a symbolic link to a file (on Windows this requires elevated permissionsBits).
      * Behind the scenes it uses `fs.symlinkSync()`.
-     * @param linkSource - The absolute or relative path to the destination where the link should be created.
-     * @param linkTarget - The absolute or relative path to the target of the link.
      */
-    static createSymbolicLinkFile(linkTarget: string, linkSource: string): void;
+    static createSymbolicLinkFile(options: IFileSystemCreateLinkOptions): void;
     /**
      * Creates a symbolic link to a folder (on Windows this requires elevated permissionsBits).
      * Behind the scenes it uses `fs.symlinkSync()`.
-     * @param linkSource - The absolute or relative path to the destination where the link should be created.
-     * @param linkTarget - The absolute or relative path to the target of the link.
      */
-    static createSymbolicLinkFolder(linkTarget: string, linkSource: string): void;
+    static createSymbolicLinkFolder(options: IFileSystemCreateLinkOptions): void;
     /**
      * Creates a hard link.
      * Behind the scenes it uses `fs.linkSync()`.
-     * @param linkSource - The absolute or relative path to the destination where the link should be created.
-     * @param linkTarget - The absolute or relative path to the target of the link.
      */
-    static createHardLink(linkTarget: string, linkSource: string): void;
+    static createHardLink(options: IFileSystemCreateLinkOptions): void;
     /**
@@ -365,0 +316,0 @@ * Follows a link to its destination and returns the absolute path to the final target of the link.

lib/FileSystem.js

@@ -21,3 +21,3 @@ "use strict";
  * Note that in the documentation, we refer to "filesystem objects", this can be a
- * file, folder, synbolic link, hard link, directory junction, etc.
+ * file, folder, symbolic link, hard link, directory junction, etc.
  *
@@ -104,12 +104,9 @@ * @public
      * Behind the scenes it uses `fs-extra.moveSync()`
-     * @param sourcePath - The absolute or relative path to the source file.
-     * @param targetPath - The absolute or relative path where the file should be moved to.
-     * @param options - Optional settings that can change the behavior. Type: `IFileSystemMoveOptions`
      */
-    static move(sourcePath, targetPath, options) {
+    static move(options) {
         options = Object.assign({ overwrite: true, ensureFolderExists: false }, options);
         if (options.ensureFolderExists) {
-            FileSystem.ensureFolder(pathUtilities.basename(sourcePath));
+            FileSystem.ensureFolder(pathUtilities.basename(options.sourcePath));
         }
-        fsx.moveSync(sourcePath, targetPath, { overwrite: options.overwrite });
+        fsx.moveSync(options.sourcePath, options.destinationPath, { overwrite: options.overwrite });
     }
@@ -211,7 +208,5 @@ // ===============
      * Behind the scenes it uses `fs.copyFileSync()`.
-     * @param sourcePath - The absolute or relative path to the source file to be copied.
-     * @param destinationPath - The absolute or relative path to the new copy that will be created.
      */
-    static copyFile(sourcePath, destinationPath) {
-        fsx.copySync(sourcePath, destinationPath);
+    static copyFile(options) {
+        fsx.copySync(options.sourcePath, options.destinationPath);
     }
@@ -252,8 +247,6 @@ /**
      * Behind the scenes it uses `fs.symlinkSync()`.
-     * @param linkSource - The absolute or relative path to the destination where the link should be created.
-     * @param linkTarget - The absolute or relative path to the target of the link.
      */
-    static createSymbolicLinkJunction(linkTarget, linkSource) {
+    static createSymbolicLinkJunction(options) {
         // For directories, we use a Windows "junction".  On POSIX operating systems, this produces a regular symlink.
-        fsx.symlinkSync(linkTarget, linkSource, 'junction');
+        fsx.symlinkSync(options.linkTargetPath, options.newLinkPath, 'junction');
     }
@@ -263,7 +256,5 @@ /**
      * Behind the scenes it uses `fs.symlinkSync()`.
-     * @param linkSource - The absolute or relative path to the destination where the link should be created.
-     * @param linkTarget - The absolute or relative path to the target of the link.
      */
-    static createSymbolicLinkFile(linkTarget, linkSource) {
-        fsx.symlinkSync(linkSource, linkTarget, 'file');
+    static createSymbolicLinkFile(options) {
+        fsx.symlinkSync(options.linkTargetPath, options.newLinkPath, 'file');
     }
@@ -273,7 +264,5 @@ /**
      * Behind the scenes it uses `fs.symlinkSync()`.
-     * @param linkSource - The absolute or relative path to the destination where the link should be created.
-     * @param linkTarget - The absolute or relative path to the target of the link.
      */
-    static createSymbolicLinkFolder(linkTarget, linkSource) {
-        fsx.symlinkSync(linkSource, linkTarget, 'dir');
+    static createSymbolicLinkFolder(options) {
+        fsx.symlinkSync(options.linkTargetPath, options.newLinkPath, 'dir');
     }
@@ -283,7 +272,5 @@ /**
      * Behind the scenes it uses `fs.linkSync()`.
-     * @param linkSource - The absolute or relative path to the destination where the link should be created.
-     * @param linkTarget - The absolute or relative path to the target of the link.
      */
-    static createHardLink(linkTarget, linkSource) {
-        fsx.linkSync(linkSource, linkTarget);
+    static createHardLink(options) {
+        fsx.linkSync(options.linkTargetPath, options.newLinkPath);
     }
@@ -290,0 +277,0 @@ /**

lib/index.d.ts

@@ -14,2 +14,3 @@ /**
 export { MapExtensions } from './MapExtensions';
+export { PosixModeBits } from './PosixModeBits';
 export { ProtectableMap, IProtectableMapParameters } from './ProtectableMap';
@@ -20,3 +21,3 @@ export { IPackageJsonLookupParameters, PackageJsonLookup } from './PackageJsonLookup';
 export { Text, NewlineKind } from './Text';
-export { FileSystem, IReadFolderOptions, IWriteFileOptions, IReadFileOptions, IFileSystemMoveOptions, IDeleteFileOptions, PosixModeBits, IUpdateTimeParameters } from './FileSystem';
+export { FileSystem, IFileSystemReadFolderOptions, IFileSystemWriteFileOptions, IFileSystemReadFileOptions, IFileSystemMoveOptions, IFileSystemCopyFileOptions, IFileSystemDeleteFileOptions, IFileSystemUpdateTimeParameters, IFileSystemCreateLinkOptions } from './FileSystem';
 export { FileWriter, IFileWriterFlags } from './FileWriter';

lib/Text.d.ts

 /**
+ * The allowed types of encodings, as supported by Node.js
+ * @public
+ */
+export declare const enum Encoding {
+    Utf8 = "utf8",
+}
+/**
  * Enumeration controlling conversion of newline characters.
@@ -3,0 +10,0 @@ * @public

package.json

 {
   "name": "@microsoft/node-core-library",
-  "version": "2.2.1",
+  "version": "3.0.0",
   "description": "Core libraries that every NodeJS toolchain project should use",
@@ -25,4 +25,4 @@ "main": "lib/index.js",
     "gulp": "~3.9.1",
-    "@microsoft/node-library-build": "4.4.0"
+    "@microsoft/node-library-build": "4.4.11"
   }
 }

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

513681

increased by0.16%

Number of package files

92

increased by3.37%

Lines of code

6519

increased by1.05%

No dependency changes