Optional baseGets or sets the length of the array. This is a number one higher than the highest index in the array.
Asynchronously copies files and directories in the array into dest directory.
If PathNiceArr.base is set, the files and directories in the array will maintain
structure relative to it when copying.
destination path of each copied item wrapped in Promise
destination directory to copy into.
Optional options: { dereference?: null | boolean; errorOnExist?: null | boolean; filter?: null | ((src: string, dest: string) => boolean | Promise<boolean>); force?: null | boolean; preserveTimestamps?: null | boolean; recursive?: null | boolean; verbatimSymlinks?: null | boolean }options.force: overwrite existing file or directory. The copy operation will
ignore errors if you set this to false and the destination exists. Use the
errorOnExist option to change this behavior. Default: true.
options.dereference: dereference symlinks. Default: false.options.errorOnExist: when force is false, and the destination exists, throw an
error. Default: false.options.filter: Function to filter copied files/directories. Return true to copy
the item, false to ignore it. Can also return a Promise that resolves to true or
false. Default: undefined.options.preserveTimestamps: When true timestamps from src will be preserved.
Default: false.options.recursive: copy directories recursively. Default: trueoptions.verbatimSymlinks: When true, path resolution for symlinks will be
skipped. Default: falseOptional dereference?: null | booleanOptional errorOptional filter?: null | ((src: string, dest: string) => boolean | Promise<boolean>)Optional force?: null | booleanOptional preserveOptional recursive?: null | booleanOptional verbatimAsynchronously moves files and directories in the array into dest directory, even across devices, including subdirectories and files when moving a directory.
If PathNiceArr.base is set, the files and directories in the array will maintain
structure relative to it when moving.
destination path of each moved item wrapped in Promise
destination to move to. Note: When src is a file, dest must be a file and when src is a directory, dest must be a directory.
Optional options: { overwrite?: null | boolean }options.overwrite: overwrite existing file or directory. Default: false
Optional overwrite?: null | booleanAsynchronously removes files and directories in the array. The directories can have contents. If one of the paths does not exist, silently does nothing for it.
original paths wrapped in Promise
Watch file changes with chokidar for a more friendly and powerful API.
This method is equivalent to calling chokidar.watch(paths, options), where paths
is populated with the current path array and the options accepted by this method are
passed to it.
See https://github.com/paulmillr/chokidar#api for full documents.
⚠️ Note: chokidar can only use the original node:fs module. Calling this method
will result in an error if you are using a path-nice generated via bindFS() that
is bound to another fs implementation. If you are sure your operation makes sense,
enable options.forceEvenDifferentFS to ignore this error.
Optional options: WatchOptions & { forceEvenDifferentFS?: boolean }Synchronously copies files and directories in the array into dest directory.
If PathNiceArr.base is set, the files and directories in the array will maintain
structure relative to it when copying.
destination path of each copied item wrapped in Promise
destination directory to copy into.
Optional options: { dereference?: null | boolean; errorOnExist?: null | boolean; filter?: null | ((src: string, dest: string) => boolean); force?: null | boolean; preserveTimestamps?: null | boolean; recursive?: null | boolean; verbatimSymlinks?: null | boolean }options.force: overwrite existing file or directory. The copy operation will
ignore errors if you set this to false and the destination exists. Use the
errorOnExist option to change this behavior. Default: true.
options.dereference: dereference symlinks. Default: false.options.errorOnExist: when force is false, and the destination exists, throw an
error. Default: false.options.filter: Function to filter copied files/directories. Return true to copy
the item, false to ignore it. Default: undefined.options.preserveTimestamps: When true timestamps from src will be preserved.
Default: false.options.recursive: copy directories recursively. Default: trueoptions.verbatimSymlinks: When true, path resolution for symlinks will be
skipped. Default: falseOptional dereference?: null | booleanOptional errorOptional filter?: null | ((src: string, dest: string) => boolean)Optional force?: null | booleanOptional preserveOptional recursive?: null | booleanOptional verbatimSynchronously moves files and directories in the array into dest directory, even across devices, including subdirectories and files when moving a directory.
If PathNiceArr.base is set, the files and directories in the array will maintain
structure relative to it when moving.
destination path of each moved item wrapped in Promise
destination to move to. Note: When src is a file, dest must be a file and when src is a directory, dest must be a directory.
Optional options: { overwrite?: null | boolean }options.overwrite: overwrite existing file or directory. Default: false
Optional overwrite?: null | booleanSynchronously removes files and directories in the array. The directory can have contents. If one of the paths does not exist, silently does nothing for it.
original paths wrapped in Promise
Iterator
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
Takes an integer value and returns the item at that index, allowing for positive and negative integers. Negative integers count back from the last item in the array.
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
Rest ...items: ConcatArray<PathNice<unknown>>[]Additional arrays and/or items to add to the end of the array.
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
If target is negative, it is treated as length+target where length is the length of the array.
If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end: numberIf not specified, length of the this object is used as its default value.
Returns an iterable of key, value pairs for every entry in the array
Determines whether all the members of an array satisfy the specified test.
A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Determines whether all the members of an array satisfy the specified test.
A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Changes all array elements from start to end index to a static value and returns the modified array
value to fill array section with
Optional start: numberindex to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end: numberindex to stop filling the array at. If end is negative, it is treated as length+end.
Returns the elements of an array that meet the condition specified in a callback function.
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
Optional depth: DThe maximum recursion depth
Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.
A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg: ThisAn object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.
Performs the specified action for each element in an array.
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Determines whether an array includes a certain element, returning true or false as appropriate.
The element to search for.
Optional fromIndex: numberThe position in this array at which to begin searching for searchElement.
Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
The value to locate in the array.
Optional fromIndex: numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Adds all the elements of an array into a string, separated by the specified separator string.
Optional separator: stringA string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.
Returns an iterable of keys in the array
Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
The value to locate in the array.
Optional fromIndex: numberThe array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.
Calls a defined callback function on each element of an array, and returns an array that contains the results.
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
Appends new elements to the end of an array, and returns the new length of the array.
Rest ...items: PathNice<unknown>[]New elements to add to the array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.
Optional start: numberThe beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.
Optional end: numberThe end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.
Determines whether the specified callback function returns true for any element of an array.
A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Sorts an array in place. This method mutates the array and returns a reference to the same array.
Optional compareFn: ((a: PathNice<unknown>, b: PathNice<unknown>) => number)Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.
[11,2,22,1].sort((a, b) => a - b)
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
An array containing the elements that were deleted.
The zero-based location in the array from which to start removing elements.
Optional deleteCount: numberThe number of elements to remove.
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
An array containing the elements that were deleted.
The zero-based location in the array from which to start removing elements.
The number of elements to remove.
Rest ...items: PathNice<unknown>[]Elements to insert into the array in place of the deleted elements.
Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
Returns a string representation of an array.
Inserts new elements at the start of an array, and returns the new length of the array.
Rest ...items: PathNice<unknown>[]Elements to insert at the start of the array.
Returns an iterable of values in the array
Generated using TypeDoc
If set, the files and directories in the array will maintain structure relative to
basewhen copying / moving.