The element to filter in or out.
A filter is a test function which determines whether or not a given element should be kept.
The element to filter in or out.
Retrieves all the elements of an iterable. The iterable should be finite.
The type of iterated elements.
The iterable from which to retrieve all the elements.
The array of all the elements of the given iterable in sequential order.
Retrieves all the elements of an iterable. The iterable should be finite.
The type of iterated elements.
The iterable from which to retrieve all the elements.
The array of all the elements of the given iterable in sequential order.
A conjunction is a filter which combines a given array of filters using logical conjunction. This means that any element that passes the combined test has passed all of the filters.
The type of elements to filter.
The filters to combine in conjunction.
The logical conjunction of the given tests.
A conjunction is a filter which combines a given array of filters using logical conjunction. This means that any element that passes the combined test has passed all of the filters.
The type of elements to filter.
The filters to combine in conjunction.
The logical conjunction of the given tests.
A disjunction is a filter which combines a given array of filters using logical disjunction. This means that any element that passes the combined test has passed at least one of the filters.
The type of elements to filter.
The filters to combine in disjunction.
The logical disjunction of the given tests.
A disjunction is a filter which combines a given array of filters using logical disjunction. This means that any element that passes the combined test has passed at least one of the filters.
The type of elements to filter.
The filters to combine in disjunction.
The logical disjunction of the given tests.
Constructs an iterable over the downward directories starting from the current working directory. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once. The current working directory is not yielded.
An iterable over the downward directories.
Constructs an iterable over the downward directories starting from the current working directory and down to a given maximum depth of a directory. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once. The start directory is not yielded.
The maximum depth of a read directory relative to the start directory. This maximum depth should be zero or positive.
An iterable over the downward directories down to the maximum depth.
Constructs an iterable over the downward directories starting from a given path. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once. The start directory is not yielded.
The start directory from which to start the downward traversal.
An iterable over the downward directories.
Constructs an iterable over the downward directories starting from a given path and down to a given maximum depth of a directory. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once. The start directory is not yielded.
The start directory from which to start the downward traversal.
The maximum depth of a read directory relative to the start directory. This maximum depth should be zero or positive.
An iterable over the downward directories down to the maximum depth.
Constructs an iterable over the downward directories starting from the current working directory. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once. The start directory is not yielded.
An iterable over the downward directories.
Constructs an iterable over the downward directories starting from the current working directory and down to a given maximum depth of a directory. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once. The start directory is not yielded.
The maximum depth of a read directory relative to the start directory. This maximum depth should be zero or positive.
An iterable over the downward directories down to the maximum depth.
Constructs an iterable over the downward directories starting from a given path. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once. The start directory is not yielded.
The start directory from which to start the downward traversal.
An iterable over the downward directories.
Constructs an iterable over the downward directories starting from a given path and down to a given maximum depth of a directory. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once. The start directory is not yielded.
The start directory from which to start the downward traversal.
The maximum depth of a read directory relative to the start directory. This maximum depth should be zero or positive.
An iterable over the downward directories down to the maximum depth.
Constructs an iterable over the downward files starting from the current working directory. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once.
An iterable over the downward files.
Constructs an iterable over the downward files starting from the current working directory and down to a given maximum depth of a directory. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once.
The maximum depth of a read directory relative to the start directory. This maximum depth should be zero or positive.
An iterable over the downward files down to the maximum depth.
Constructs an iterable over the downward files starting from a given path. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once.
The starting directory from which to start the downward traversal.
An iterable over the downward files.
Constructs an iterable over the downward files starting from a given path and down to a given maximum depth of a directory. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once.
The starting directory from which to start the downward traversal.
The maximum depth of a read directory relative to the start directory. This maximum depth should be zero or positive.
An iterable over the downward files down to the maximum depth.
Constructs an iterable over the downward files starting from the current working directory. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once.
An iterable over the downward files.
Constructs an iterable over the downward files starting from the current working directory and down to a given maximum depth of a directory. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once.
The maximum depth of a read directory relative to the start directory. This maximum depth should be zero or positive.
An iterable over the downward files down to the maximum depth.
Constructs an iterable over the downward files starting from a given path. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once.
The starting directory from which to start the downward traversal.
An iterable over the downward files.
Constructs an iterable over the downward files starting from a given path and down to a given maximum depth of a directory. Symbolic links are followed, and the directories are traversed in breadth-first order. Directories are read only once.
The starting directory from which to start the downward traversal.
The maximum depth of a read directory relative to the start directory. This maximum depth should be zero or positive.
An iterable over the downward files down to the maximum depth.
Filters out elements of an iterable which don't pass a given filter.
The type of elements to filter.
The iterable to filter.
The filter an element must pass in order to be filtered in.
An iterable over the filtered elements.
Filters out elements of an iterable which don't pass a given filter.
The type of elements to filter.
The iterable to filter.
The filter an element must pass in order to be filtered in.
An iterable over the filtered elements.
Reads the current working directory and performs the given tests on all of its soft and hard-linked files in order to find the files or directories whose path passes all of the tests.
The sequence of tests a file or directory's path must pass in
order to be considered among the desired paths to be found. If a path does
not match any of the tests, then it is ignored. If no tests are specified,
then the promise will arbitrarily be resolved to null.
The files or directories' path in the current working directory that pass all the tests. These paths are sorted alphanumerically.
Reads the given directories and performs the given tests on all of their soft and hard-linked files in order to find the files or directories' path that passes all of the tests.
The directories' path in which to search for files or directories' path that pass all the tests. If any of these directories is not absolute, then it is resolved relative to the current working directory.
The sequence of tests a file or directory's path must pass in order to be considered among the paths found. If a path does not match any of the tests, then it is ignored.
A promise for the files or directories' path in the directories that pass all the tests. The paths are returned in order of directory and sorted alphanumerically by base name in each directory.
Reads the current working directory and performs the given tests on all of its soft and hard-linked files in order to find the files or directories whose path passes all of the tests.
The sequence of tests a file or directory's path must pass in
order to be considered among the desired paths to be found. If a path does
not match any of the tests, then it is ignored. If no tests are specified,
then the function will arbitrarily return null.
The files or directories' path in the current working directory that pass all the tests. These paths are sorted alphanumerically.
Reads the given directories and performs the given tests on all of their soft and hard-linked files in order to find the files or directories whose path passes all of the tests.
The directories' path in which to search for all the files or directories' path that pass all the tests. If any of these directories is not absolute, then it is resolved relative to the current working directory.
The sequence of tests a file or directory's path must pass in
order to be considered among the desired paths to be found. If a path does
not match any of the tests, then it is ignored. If no tests are specified,
then the function will arbitrarily return null.
The files or directories' path in the given directories that pass all the tests. The paths are returned in order of directory and sorted alphanumerically by base name in each directory.
Reads the current working directory and performs the given tests on all of its soft and hard-linked files in order to find the first file or directory's path in it that passes all of the tests.
The sequence of tests a file or directory's path must pass in
order to be considered the desired path to be found. If a path does not
match any of the tests, then it is ignored. If no tests are specified, then
the promise will arbitrarily resolve to null. These tests should be
declared such that there can only exist one path that passes them all,
otherwise the function may not be deterministic. A test for a path whose
base name is equal to a string has that uniqueness.
A promise for either the path to the file or directory that is the
first one found in the current working directory such that it passes all
the tests, or null if there is no such path in the current working
directory.
Reads the given directories and performs the given tests on all of their soft and hard-linked files in order to find the first file or directory's path in its directory that passes all of the tests.
The directories' path in which to search for a single file or directory's path that passes all the tests. If any of these directories is not absolute, then it is resolved relative to the current working directory.
The sequence of tests a file's path must pass in order to be
considered the desired file to be found. If a file's path does not match
any of the tests, then it is ignored. If no tests are specified, then the
promise will arbitrarily resolve to null. These tests should be declared
such that there can only exist one path that passes them all, otherwise the
function may not be deterministic. A test for a path whose base name is
equal to a string has that uniqueness.
A promise for either the path to the file or directory that is the
first one found in the directories such that it passes all the tests, or
null if there is no such path in any of the directories.
Reads the current working directory and performs the given tests on all of its soft and hard-linked files in order to find the first file or directory's path in it that passes all of the tests.
The sequence of tests a file or directory's path must pass in
order to be considered the desired file to be found. If a path does not
match any of the tests, then it is ignored. If no tests are specified, then
the function will arbitrarily return null. These tests should be declared
such that there can only exist one path that passes them all, otherwise the
function may not be deterministic. A test for a path whose base name is
equal to a string has that uniqueness.
Either the path to the file or directory that is the first one
found in the current working directory such that it passes all the tests,
or null if there is no such path in the current working directory.
Reads the given directories and performs the given tests on all of their soft and hard-linked files in order to find the first file or directory's path in its directory that passes all of the tests.
The directories' path in which to search for the first file or directory's path that passes all the tests. If any of these directories is not absolute, then it is resolved relative to the current working directory.
The sequence of tests a file or directory's path must pass in
order to be considered the desired path to be found. If a file's path does
not match any of the tests, then it is ignored. If no tests are specified,
then the function will arbitrarily return null. These tests should be
declared such that there can only exist one path that passes them all,
otherwise the function may not be deterministic. A test for a path whose
base name is equal to a string has that uniqueness.
Either the path to the file or directory that is the first one
found in the directories such that it passes all the tests, or null if
there is no such path in any of the directories.
Reads the current working directory and performs the given tests on all of its soft and hard-linked files in order to find the first and only file or directory's path in it that passes all of the tests.
The sequence of tests a file or directory's path must pass in
order to be considered the desired file to be found. If a path does not
match any of the tests, then it is ignored. If two or more paths satisfy
all of the tests, then the promise is rejected, since only a single path is
desired. If no tests are specified, then the promise will arbitrarily
resolve to null.
A promise for either the path to the file or directory that is the
first and the only one found in the current working directory such that it
passes all the tests, or null if there is no such path in the current
working directory.
Reads the given directories and performs the given tests on all of their soft and hard-linked files in order to find the first and only file or directory's path in its directory that passes all of the tests.
The directories' path in which to search for a single file or directory's path that passes all the tests. If any of these directories is not absolute, then it is resolved relative to the current working directory.
The sequence of tests a file or directory's path must pass in
order to be considered the desired path to be found. If a path does not
match any of the tests, then it is ignored. If two or more paths satisfy
all of the tests, then the promise is rejected, since only a single path is
desired. If no tests are specified, then the promise will arbitrarily
resolve to null.
A promise for either the path to the file or directory that is the
first and the only one found in the directories such that it passes all the
tests, or null if there is no such file in any of the directories.
Reads the current working directory and performs the given tests on all of its soft and hard-linked files in order to find the first and only file or directory's path in it that passes all of the tests.
The sequence of tests a file or directory's path must pass in
order to be considered the desired path to be found. If a path does not
match any of the tests, then it is ignored. If two or more paths satisfy
all of the tests, then an error is thrown, since only a single path is
desired. If no tests are specified, then the function will arbitrarily
return null.
Either the path to the file or directory that is the first and the
only one found in the current working directory such that it passes all the
tests, or null if there is no such path in the current working directory.
Reads the given directories and performs the given tests on all of their soft and hard-linked files in order to find the first and only file or directory's path in its directory that passes all of the tests.
The directories' path in which to search for a single file's path that passes all the tests. If any of these directories is not absolute, then it is resolved relative to the current working directory.
The sequence of tests a file or directory's path must pass in
order to be considered the desired path to be found. If a path does not
match any of the tests, then it is ignored. If two or more paths satisfy
all of the tests, then an error is thrown, since only a single path is
desired. If no tests are specified, then the function will arbitrarily
return null.
Either the path to the file or directory that is the first and the
only one found in the directories such that it passes all the tests, or
null if there is no such path in any of the directories.
Retrieves the first element of an iterable.
The type of iterated elements.
The iterable from which to retrieve the first element.
The first element of the given iterable.
Retrieves the first element of an iterable.
The type of iterated elements.
The iterable from which to retrieve the first element.
The first element of the given iterable.
Constructs a filter which determines whether of not a directory has a file or directory's path that passes a given test. The returned filter will arbitrarily be false for any path that isn't a directory. The path should have already been resolved.
The test to perform on each files' path until there is a match.
A filter which determines whether of not a directory has a file or directory's path that passes a given test.
Constructs a filter which determines whether of not a directory has a file or directory's path that passes a given test. The returned filter will arbitrarily be false for any path that isn't a directory. The path should have already been resolved.
The test to perform on each files' path until there is a match.
A filter which determines whether of not a directory has a file or directory's path that passes a given test.
Constructs a filter which determines whether or not all the path segments of
a path pass a sequence of tests. In order for a path to match, there must not
be a path segment that fails a test. If no tests are provided, then the
filter will return false regardless of the path it checks.
The sequence of tests each path segment must pass in order for the path to match.
A filter that determines whether or not all the path segments of a path pass a sequence of tests
Safely determines whether or not the file at a given path is a directory. Is there is no file at the given path, then this returns false.
Whether or not the file at the given path is a directory.
Safely determines whether or not the file at a given path is a directory. Is there is no file at the given path, then this returns false.
Whether or not the file at the given path is a directory.
Safely determines whether or not the file at a given path is a file. Is there is no file at the given path, then this returns false.
Whether or not the file at the given path is a file.
Safely determines whether or not the file at a given path is a file. Is there is no file at the given path, then this returns false.
Whether or not the file at the given path is a file.
Constructs a filter which determines whether or not a given path has a base
name matching a given full base name, a regular expression or a function. If
a path's base name is equal to any of the given string base names, or if it
matches with any of the regular expressions, or if any of the base name
functions returns true, then the filter returns true.
The set of tests run on the paths to check.
A filter which determines whether or not a given path has a base name matching a given full base name, a regular expression or a function.
Constructs a filter which determines whether or not a given path has a
directory name matching a given full directory name, a regular expression or
a function. If a path's directory name is equal to any of the given string
directory names, or if it matches with any of the regular expressions, or if
any of the directory name functions returns true, then the filter returns
true.
The set of tests run on the paths to check.
A filter which determines whether or not a given path has a directory name matching a given full directory name, a regular expression or a function.
Constructs a filter which determines whether or not a given path has an
extension name matching a given full extension name, a regular expression or
a function. If a path's extension name is equal to any of the given string
extension names, or if it matches with any of the regular expressions, or if
any of the extension name functions returns true, then the filter returns
true.
The set of tests run on the paths to check.
A filter which determines whether or not a given path has an extension name matching a given full extension name, a regular expression or a function.
Constructs a filter which determines whether or not a given path has a name
matching a given full name, a regular expression or a function. The name of a
path corresponds to its base name without its extension name. If a path's
name is equal to any of the given string names, or if it matches with any of
the regular expressions, or if any of the name functions returns true, then
the filter returns true.
The set of tests run on the paths to check.
A filter which determines whether or not a given path has a base name matching a given full base name, a regular expression or a function.
Retrieves the first and only element of an iterable.
The type of iterated elements.
The iterable from which to retrieve the first and only element.
The first and only element of the given iterable.
Retrieves the first and only element of an iterable.
The type of iterated elements.
The iterable from which to retrieve the first and only element.
The first and only element of the given iterable.
Constructs a generator which yields the files read asynchronously from the given directory's path. The files are not yielded in any particular order.
The path to the directory to read. If it is not absolute, then it is resolved relative to the current working directory.
An iterable over the read files of the given directory's path.
Constructs a generator which yields the files read synchronously from the given directory's path. The files are not yielded in any particular order.
The path to the directory to read. If it is not absolute, then it is resolved relative to the current working directory.
An iterable over the read files of the given directory's path.
Constructs a generator which yields the files read asynchronously from the given directory paths. The files are yielded in order of directory iterated over, but are not yielded in any particular order in each directory.
The paths to the directories to read. If any of them is not absolute, then it is resolved relative to the current working directory.
An iterable over the read files of the given directory paths.
Constructs a generator which yields the files read synchronously from the given directory paths. The files are yielded in order of directory iterated over, but are not yielded in any particular order in each directory.
The paths to the directories to read. If any of them is not absolute, then it is resolved relative to the current working directory.
An iterable over the read files of the given directory paths.
Constructs a generator which yields the segments of a path. These segments are based off the normalized path, which may or may not be absolute. Each yielded segment must have at least one non-special character, meaning that a segment cannot consist solely of dots or segment separators.
The path from which to yield the segments.
An iterable over the segments of the normalized path.
Constructs an iterable over the upward directories starting from the current working directory. The current working directory is not yielded. The directories are yielded in ascending order of height relative to the current working directory.
An iterable over the upward directories.
Constructs an iterable over the upward directories starting from the given path. The start path is not yielded. If the start path is a file, then its directory is yielded. The directories are yielded in ascending order of height relative to the given start path.
The start path from which to traverse upwards.
An iterable over the upward directories.
Constructs an iterable over the upward directories starting from the given path and up to a given maximum height. The start path is not yielded. If the start path is a file, then its directory is yielded. The directories are yielded in ascending order of height relative to the given start path. Each yielded directory has a height greater than one, and less than or equal to the given maximum height.
The start path from which to traverse upwards.
The maximum height of any yielded directory path.
An iterable over the upward directories.
Constructs an iterable over the upward directories starting from the given path and up to a given end path. The start path is not yielded. If the start path is a file, then its directory is yielded. The directories are yielded in ascending order of height relative to the given start path. If the end path is not parent to the start path, then the iteration ends with the root of the start path. The iteration has to encounter the end path in order to end once it is yielded.
The start path from which to traverse upwards.
The path on which the iteration will end if it is encountered in the upward traversal.
An iterable over the upward directories.
Constructs an iterable over the upward directories starting from the current working directory. The current working directory is not yielded. The directories are yielded in ascending order of height relative to the current working directory.
An iterable over the upward directories.
Constructs an iterable over the upward directories starting from the given path. The start path is not yielded. If the start path is a file, then its directory is yielded. The directories are yielded in ascending order of height relative to the given start path.
The start path from which to traverse upwards.
An iterable over the upward directories.
Constructs an iterable over the upward directories starting from the given path and up to a given maximum height. The start path is not yielded. If the start path is a file, then its directory is yielded. The directories are yielded in ascending order of height relative to the given start path. Each yielded directory has a height greater than one, and less than or equal to the given maximum height.
The start path from which to traverse upwards.
The maximum height of any yielded directory path.
An iterable over the upward directories.
Constructs an iterable over the upward directories starting from the given path and up to a given end path. The start path is not yielded. If the start path is a file, then its directory is yielded. The directories are yielded in ascending order of height relative to the given start path. If the end path is not parent to the start path, then the iteration ends with the root of the start path. The iteration has to encounter the end path in order to end once it is yielded.
The start path from which to traverse upwards.
The path on which the iteration will end if it is encountered in the upward traversal.
An iterable over the upward directories.
Constructs an iterable over the files in the upward directories relative to the current working directory, up to the root inclusively of the current working directory. The directories are traversed in increasing order of height relative to the start directory. The start directory is not read.
An iterable over the upward files.
Constructs an iterable over the files in the upward directories relative to the current working directory, up to the upward directory whose height relative to the current working directory is equal to the given maximum height. The directories are traversed in increasing order of height relative to the start directory. The start directory is not read.
The maximum height of a directory. The height of the start directory is zero. This value should be greater than or equal to one.
An iterable over the upward files.
Constructs an iterable over the files in the upward directories relative to the start path, up to the root inclusively of the start path directory. The directories are traversed in increasing order of height relative to the start directory. The start path is not read if it is a directory. If the start path is a file, then its directory is the first directory to be read.
The start path of the upward traversal.
An iterable over the upward files.
Constructs an iterable over the files in the upward directories relative to the start path, up to the upward directory whose height relative to the start path is equal to the given maximum height. The directories are traversed in increasing order of height relative to the start directory. The start path is not read if it is a directory. If the start path is a file, then its directory is the first directory to be read, if its height does not exceed the maximum height.
The start path of the upward traversal.
The maximum height of a directory. The height of the start path is zero. This value should be greater than or equal to one.
An iterable over the upward files.
Constructs an iterable over the files in the upward directories relative to the start path, up to an end path. The directories are traversed in increasing order of height relative to the start directory. The start path is not read if it is a directory. If the start path is a file, then its directory is the first directory to be read. If the end directory is not parent to the start path, then all the upward paths from the start path are yielded up to its root. The iteration stops once the end directory is reached and its files are yielded.
The start path of the upward traversal.
The end directory at which point all the upward directories have been read.
An iterable over the upward files.
Constructs an iterable over the files in the upward directories relative to the current working directory, up to the root inclusively of the current working directory. The directories are traversed in increasing order of height relative to the start directory. The start directory is not read.
An iterable over the upward files.
Constructs an iterable over the files in the upward directories relative to the current working directory, up to the upward directory whose height relative to the current working directory is equal to the given maximum height. The directories are traversed in increasing order of height relative to the start directory. The start directory is not read.
The maximum height of a directory. The height of the start directory is zero. This value should be greater than or equal to one.
An iterable over the upward files.
Constructs an iterable over the files in the upward directories relative to the start path, up to the root inclusively of the start path directory. The directories are traversed in increasing order of height relative to the start directory. The start path is not read if it is a directory. If the start path is a file, then its directory is the first directory to be read.
The start path of the upward traversal.
An iterable over the upward files.
Constructs an iterable over the files in the upward directories relative to the start path, up to the upward directory whose height relative to the start path is equal to the given maximum height. The directories are traversed in increasing order of height relative to the start directory. The start path is not read if it is a directory. If the start path is a file, then its directory is the first directory to be read, if its height does not exceed the maximum height.
The start path of the upward traversal.
The maximum height of a directory. The height of the start path is zero. This value should be greater than or equal to one.
An iterable over the upward files.
Constructs an iterable over the files in the upward directories relative to the start path, up to an end path. The directories are traversed in increasing order of height relative to the start directory. The start path is not read if it is a directory. If the start path is a file, then its directory is the first directory to be read. If the end directory is not parent to the start path, then all the upward paths from the start path are yielded up to its root. The iteration stops once the end directory is reached and its files are yielded.
The start path of the upward traversal.
The end directory at which point all the upward directories have been read.
An iterable over the upward files.
Generated using TypeDoc
A filter is a test function which determines whether or not a given element should be kept.