mergeArgs: {
    <D extends object>(
        defaults: D,
        inputs?: undefined,
        recursive?: boolean,
    ): D;
    <D extends object, I extends Partial<D>>(
        defaults: D,
        inputs: I,
        recursive?: false,
    ): D & I;
    <D extends object, I extends Partial<D> | RecursivePartial<D>>(
        defaults: D,
        inputs: I,
        recursive: true,
    ): D & I;
    <D extends object, I extends Partial<D> | RecursivePartial<D>>(
        defaults: D,
        inputs?: I,
        recursive?: boolean,
    ): D | D & I;
} = mergeArgs

An alias for this package's mergeArgs().

Type declaration

- <D extends object>(defaults: D, inputs?: undefined, recursive?: boolean): D
- Inputs can be undefined, and if so, the default is returned.
  Type Parameters
  - D extends object
    Default object type.
  Parameters
  - defaults: D
    Default values (if not specified in inputs).
  - Optionalinputs: undefined
    Overriding values (changes to make).
  - Optionalrecursive: boolean
    Optional. Whether to merge the object recursively. Default false.
  Returns D
  Resulting object with all the defaults and inputs keys with either default values or input values, as appropriate.
- <D extends object, I extends Partial<D>>(
      defaults: D,
      inputs: I,
      recursive?: false,
  ): D & I
- Passing recursive as false means that the input type must be a Partial (not RecursivePartial).
  Type Parameters
  - D extends object
  - I extends Partial<D>
  Parameters
  - defaults: D
  - inputs: I
  - Optionalrecursive: false
  Returns D & I
- <D extends object, I extends Partial<D> | RecursivePartial<D>>(
      defaults: D,
      inputs: I,
      recursive: true,
  ): D & I
- Passing recursive as true means that the input type may actually be a RecursivePartial.
  Type Parameters
  - D extends object
  - I extends Partial<D> | RecursivePartial<D>
  Parameters
  - defaults: D
  - inputs: I
  - recursive: true
  Returns D & I
- <D extends object, I extends Partial<D> | RecursivePartial<D>>(
      defaults: D,
      inputs?: I,
      recursive?: boolean,
  ): D | D & I
- Universal overload.
  Type Parameters
  - D extends object
  - I extends Partial<D> | RecursivePartial<D>
  Parameters
  - defaults: D
  - Optionalinputs: I
  - Optionalrecursive: boolean
  Returns D | D & I

Properties - Args

`Readonly`args

args: node.NodeFiles.Args

A completed args object.

Properties - Classes

`Readonly`nc

nc: node.NodeConsole

The instance of NodeConsole used within this class.

Accessors - Args

ARGS_DEFAULT

get ARGS_DEFAULT(): {
    argsRecursive: true;
    copyFile: { force: true; recursive: false; rename: true };
    readDir: { recursive: false };
    readFile: {};
    root: "./";
    write: { force: boolean; rename: boolean };
}
Default args for this stage.

Returns {
    argsRecursive: true;
    copyFile: { force: true; recursive: false; rename: true };
    readDir: { recursive: false };
    readFile: {};
    root: "./";
    write: { force: boolean; rename: boolean };
}
Overrides AbstractConfigurableClass.ARGS_DEFAULT
- Defined in classes/node/NodeFiles.ts:53

Methods - Args

buildArgs

buildArgs(
    args?:
        | Partial<node.NodeFiles.Args>
        | RecursivePartial<node.NodeFiles.Args>,
): node.NodeFiles.Args
Build a complete args object.
Parameters
- Optionalargs: Partial<node.NodeFiles.Args> | RecursivePartial<node.NodeFiles.Args>
Returns node.NodeFiles.Args
Inherited from AbstractConfigurableClass.buildArgs
- Defined in classes/abstracts/AbstractConfigurableClass.ts:50

Methods - Exporters

toString

toString(): string
Overrides the default function to return a string representation of this object.

Returns string
See
Object.prototype.toString()
Inherited from AbstractConfigurableClass.toString
- Defined in classes/abstracts/AbstractConfigurableClass.ts:100

Methods - Filers

copyFile

copyFile(
    source: string,
    destination: string,
    args?: Partial<CopyFileArgs>,
): string | false
Experimental
Copies a file to another path.
Parameters
- source: string
  Location to write file.
- destination: string
  Location to copy the source path to.
- args: Partial<CopyFileArgs> = {}
  Optional configuration.
Returns string | false
Path to file if written, or false on failure.

Since
2.0.0-alpha

Since
2.0.0-alpha.1 — Now checks that the file exists first. If so, returns ''.
- Defined in classes/node/NodeFiles.ts:152

delete

delete(paths: string[], logLevel?: number, dryRun?: boolean): void
Deletes given files.
Parameters
- paths: string[]
  Paths to delete. Absolute or relative to root dir.
- logLevel: number = 0
  Base depth for console messages (via NodeConsole).
- dryRun: boolean = false
  If true, files that would be deleted are printed to the console and not deleted.
Returns void
Since
2.0.0-alpha — Renamed to delete from deleteFiles.
- Defined in classes/node/NodeFiles.ts:218

mkdir

mkdir(path: string): undefined | string
Experimental
Creates a directory.
Parameters
- path: string
Returns undefined | string
Since
2.0.0-alpha

Since
2.0.0-alpha.1 — Removed args param and now forces recursion.
- Defined in classes/node/NodeFiles.ts:330

readDir

readDir(path: string, args?: Partial<ReadDirArgs>): string[]
Experimental
Read the paths within a directory.
Parameters
- path: string
  Directory to read.
- args: Partial<ReadDirArgs> = {}
  Optional configuration.
Returns string[]
Paths within the given directory.

Since
2.0.0-alpha

Since
2.0.0-alpha.1 — Now checks that the file exists first. If so, returns ''.
- Defined in classes/node/NodeFiles.ts:352

readFile

readFile(path: string, args?: Partial<ReadFileArgs>): string
Reads a file.
Parameters
- path: string
  File to read.
- args: Partial<ReadFileArgs> = {}
  Optional configuration.
Returns string
Contents of the file.

Since
2.0.0-alpha.1 — Now checks that the file exists first. If so, returns ''.
- Defined in classes/node/NodeFiles.ts:388

write

write(
    path: string,
    content: string | string[],
    args?: Partial<WriteFileArgs>,
): string | false
Writes a file.
Parameters
- path: string
  Location to write file.
- content: string | string[]
  Contents to write.
- args: Partial<WriteFileArgs> = {}
  Optional configuration.
Returns string | false
Path to file if written, or false on failure.

Since
2.0.0-alpha — Renamed to write from writeFiles.
- Defined in classes/node/NodeFiles.ts:423

Methods - Meta

getStats

getStats(path: string): undefined | Stats
Experimental
Gets the NodeFS.Stats value for the given path.
Parameters
- path: string
Returns undefined | Stats
Since
2.0.0-alpha
- Defined in classes/node/NodeFiles.ts:274

Methods - Path-makers

basename

basename(path: string, suffix?: string | false): string
Experimental
Gets the basename of the given path.
Parameters
- path: string
- Optionalsuffix: string | false
Returns string
Since
2.0.0-alpha
- Defined in classes/node/NodeFiles.ts:498

changeBaseName

changeBaseName(path: string, newName: string): string
Changes just the file name of a path
Parameters
- path: string
- newName: string
Returns string
Full path with updated basename.
- Defined in classes/node/NodeFiles.ts:474

dirname

dirname(path: string): string
Experimental
Gets the path dirname via :fs.dirname.
Parameters
- path: string
Returns string
Since
2.0.0-alpha
- Defined in classes/node/NodeFiles.ts:261

exists

exists(path: string): boolean
Experimental
Checks whether a file, directory, or link exists at the given path.
Parameters
- path: string
Returns boolean
Since
2.0.0-alpha
- Defined in classes/node/NodeFiles.ts:521

isDirectory

isDirectory(path: string): boolean
Experimental
Checks if the given path is a directory.
Parameters
- path: string
Returns boolean
Since
2.0.0-alpha
- Defined in classes/node/NodeFiles.ts:290

isFile

isFile(path: string): boolean
Experimental
Checks if the given path is a file.
Parameters
- path: string
Returns boolean
Since
2.0.0-alpha
- Defined in classes/node/NodeFiles.ts:303

isSymLink

isSymLink(path: string): boolean
Experimental
Checks if the given path is a symbolic link.
Parameters
- path: string
Returns boolean
Since
2.0.0-alpha
- Defined in classes/node/NodeFiles.ts:316

pathRelative

pathRelative(path: string): string
Returns relative paths, based on the root defined the the opts.
Parameters
- path: string
  Path to make relative.
Returns string
- Defined in classes/node/NodeFiles.ts:532

pathResolve

pathResolve(...paths: string[]): string
Resolves relative to the root defined the the opts.
Parameters
- ...paths: string[]
  Paths to resolve.
Returns string
- Defined in classes/node/NodeFiles.ts:544

uniquePath

uniquePath(inputPath: string): string
Returns a unique version of the inputPath (i.e., where no file exists) by appending a number.
Parameters
- inputPath: string
  Path to make unique.
Returns string
Absolute, unique version of the given inputPath.

See
NodeFiles.changeBaseName Used to update the basename to test for uniqueness.
- Defined in classes/node/NodeFiles.ts:560

Class NodeFiles

Since

Hierarchy (View Summary)

Index

Constructors

Properties - Aliases

Properties - Args

Properties - Classes

Accessors - Args

Methods - Args

Methods - Exporters

Methods - Filers

Methods - Meta

Methods - Path-makers

Constructors

constructor

Parameters

Returns node.NodeFiles

Properties - Aliases

FunctionmergeArgs

Type declaration

Type Parameters

Parameters

Returns D

Type Parameters

Parameters

Returns D & I

Type Parameters

Parameters

Returns D & I

Type Parameters

Parameters

Returns D | D & I

Properties - Args

Readonlyargs

Properties - Classes

Readonlync

Accessors - Args

ARGS_DEFAULT

Returns { argsRecursive: true; copyFile: { force: true; recursive: false; rename: true }; readDir: { recursive: false }; readFile: {}; root: "./"; write: { force: boolean; rename: boolean };}

Methods - Args

buildArgs

Parameters

Returns node.NodeFiles.Args

Methods - Exporters

toString

Returns string

See

Methods - Filers

copyFile

Parameters

Returns string | false

Since

Since

delete

Parameters

Returns void

Since

mkdir

Parameters

Returns undefined | string

Since

Since

readDir

Parameters

Returns string[]

Since

Since

readFile

Parameters

Returns string

Since

write

Parameters

Returns string | false

Since

Methods - Meta

getStats

Parameters

Returns undefined | Stats

`Function`mergeArgs

`Readonly`args

`Readonly`nc

Returns {
argsRecursive: true;
copyFile: { force: true; recursive: false; rename: true };
readDir: { recursive: false };
readFile: {};
root: "./";
write: { force: boolean; rename: boolean };
}