diff --git a/.nojekyll b/.nojekyll
new file mode 100644
index 0000000..e2ac661
--- /dev/null
+++ b/.nojekyll
@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
\ No newline at end of file
diff --git a/enums/lsTypes.lsTypes.html b/enums/lsTypes.lsTypes.html
index 3655cd5..aa6a86c 100644
--- a/enums/lsTypes.lsTypes.html
+++ b/enums/lsTypes.lsTypes.html
@@ -1,4 +1,4 @@
-lsTypes | LSFND - v1.0.0
This enumeration defines the different types of listings supported by
the ls function. It specifies which file system entries should be
included in the results.
Lists files and/or directories in a specified directory path, filtering by a
regular expression pattern.
The returned entries are configurable using the additional options,
such as listing recursively to subdirectories, and filter specific file and/or
@@ -204,10 +204,10 @@
Lists files in the specified directory path, filtering by a regular
expression pattern.
The returned entries are configurable using the additional options,
such as listing recursively to subdirectories, and filter specific file and/or
@@ -197,10 +197,10 @@
Lists files in the specified directory path, filtering by a regular
expression pattern.
The returned entries are configurable using the additional options,
such as listing recursively to subdirectories, and filter specific file and/or
@@ -197,10 +197,10 @@
Lists files and/or directories in a specified directory path, filtering by a
regular expression pattern.
The returned entries are configurable using the additional options,
such as listing recursively to subdirectories, and filter specific file and/or
@@ -188,10 +188,10 @@
A promise that resolves with an array of string representing the
entries result excluding '.' and '..' or an empty array ([])
if any files and directories does not match with the specified filter options.
Lists files in the specified directory path, filtering by a regular
expression pattern.
The returned entries are configurable using the additional options,
such as listing recursively to subdirectories, and filter specific file and/or
@@ -184,10 +184,10 @@
A promise that resolves with an array of string representing the
entries result excluding '.' and '..' or an empty array ([])
if any files and directories does not match with the specified filter options.
Lists files in the specified directory path, filtering by a regular
expression pattern.
The returned entries are configurable using the additional options,
such as listing recursively to subdirectories, and filter specific file and/or
@@ -184,10 +184,10 @@
A promise that resolves with an array of string representing the
entries result excluding '.' and '..' or an empty array ([])
if any files and directories does not match with the specified filter options.
This library's primary benefit is that every implemented API runs asynchronously,
guaranteeing that they will NEVER disrupt the execution of any other processes.
-
Important Currently this library only focus on CommonJS (CJS) and ECMAScript Modules (ESM).
+
Important Currently this library only focus on CommonJS (CJS) and ECMAScript Modules (ESM).
As of version 1.0.0, this library has supported TypeScript projects with various
module types (i.e., node16, es6, and many more). Previously, it was only supports
TypeScript projects with module type of commonjs. All type declarations in this
@@ -206,7 +206,7 @@
promise with an empty array if any files and directories doesn't match with the
specified filter options.
-
Note 💡 Tip: You can combine options for more granular control. For example,
+
Note 💡 Tip: You can combine options for more granular control. For example,
you can list directories and/or files recursively while filtering by either
specific extensions or names.
The root directory of the project from where the build process starts.
This path should be a string representing a valid file system path.
-
outDir
outDir:string
The output directory where the build process will place generated files.
+
outDir
outDir:string
The output directory where the build process will place generated files.
This path should be a string representing a valid file system path.
-
tsconfig
tsconfig:string
The path to the tsconfig.json file that will be used during the build process.
+
tsconfig
tsconfig:string
The path to the tsconfig.json file that will be used during the build process.
This path should be a string representing a valid file system path relative
to the rootDir.
A list of file paths (relative to the BuildPropConfig.rootDir)
to be included during minification. Each element in the array should be a
string representing a valid file system path.
This interface defines the optional configuration options that can be passed
to every ls* functions. These options control the behavior of the directory listing.
A boolean flag indicating whether to include subdirectories in the listing.
+
Optionalrecursive
recursive?:boolean
A boolean flag indicating whether to include subdirectories in the listing.
Default Value
false
Since
0.1.0
-
Optionalmatch
match?:string | RegExp
A regular expression or string pattern used to filter the listed entries.
+
Optionalmatch
match?:string | RegExp
A regular expression or string pattern used to filter the listed entries.
Only entries matching the pattern will be included in the results.
Default Value
/.+/ (match all files)
Since
0.1.0
-
Optionalexclude
exclude?:string | RegExp
A regular expression or string pattern used to exclude entries from the
+
Optionalexclude
exclude?:string | RegExp
A regular expression or string pattern used to exclude entries from the
listing. Any entries matching this pattern will be filtered out of the
results, even if they match the match pattern.
Default Value
undefined
Since
0.1.0
-
OptionalrootDir
rootDir?:string | URL
A string path representing the root directory to resolve the results to
+
OptionalrootDir
rootDir?:string | URL
A string path representing the root directory to resolve the results to
relative paths.
This option will be ignored if either one of the absolute
or basename option are enabled, this is due to their
@@ -190,7 +190,7 @@
Since
0.1.0
options.
Default Value
'.' or process.cwd()
Since
1.0.0
-
Optionalabsolute
absolute?:boolean
Determines whether to return absolute paths for all entries.
+
Optionalabsolute
absolute?:boolean
Determines whether to return absolute paths for all entries.
When enabled (i.e., set to true), each entry of the returned results
will be an absolute path. Otherwise, paths will be relative to the directory
specified in the rootDir field.
Whether to make the returned result paths only have their basenames, trimming any
+
Optionalbasename
basename?:boolean
Whether to make the returned result paths only have their basenames, trimming any
directories behind the path separator (i.e., \\ in Windows, and / in POSIX).
When set to true, the returned paths will only include the file and/or
directory names itself. This can be useful if you need only the names while
@@ -240,10 +240,10 @@
A module that offers some functions to read and list files and/or directories
in a specified directory with support filtering using regular expression pattern.
Copyright (c) 2024 Ryuu Mitsuki. All rights reserved.
This type alias represents an array of StringPath. It is typically used to
represent the list of file and/or directory entries returned by the ls* functions.
Each entry in the array represents the path of a file or directory within
the listed directory.
This type alias represents the possible return values of the ls* functions.
It can be either a LsEntries array containing the list of file paths,
or null to indicate an error.
ResolvedLsOptions:{ [T in keyof LsOptions]-?: T extends "exclude" ? NonNullable<LsOptions[T]> | undefined : NonNullable<LsOptions[T]> }
Represents resolved options type for the ls* functions, where all properties are
required and both null and undefined values are omitted, except for the
exclude property which keeps the undefined type.
This enumeration defines the different types of listings supported by
the ls function. It specifies which file system entries should be
included in the results.
See
For more details, refer to lsTypes enum documentation.
This enumeration defines the different types of listings supported by +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Enumeration lsTypes
ReadonlyThis enumeration defines the different types of listings supported by the ls function. It specifies which file system entries should be included in the results.
Since
0.1.0
See
ls
-Index
Enumeration Members
Index
Enumeration Members
Enumeration Members
LS_
This option lists both regular files and directories in the output. You can also use other number types for alias, like:
-LS_
This option filters the output to include only directory entries. +
LS_
This option filters the output to include only directory entries. You can also use other number types for alias, like:
-LS_
This option filters the output to include only regular files (non-directories). +
LS_
This option filters the output to include only regular files (non-directories). You can also use other number types for alias, like:
-Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Function ls
Lists files and/or directories in a specified directory path, filtering by a +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Function ls
Lists files and/or directories in a specified directory path, filtering by a regular expression pattern.
The returned entries are configurable using the additional options, such as listing recursively to subdirectories, and filter specific file and/or @@ -204,10 +204,10 @@
See
- lsTypes
- fs.readdir
-Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Function lsDirs
Lists files in the specified directory path, filtering by a regular +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Function lsDirs
Lists files in the specified directory path, filtering by a regular expression pattern.
The returned entries are configurable using the additional options, such as listing recursively to subdirectories, and filter specific file and/or @@ -197,10 +197,10 @@
See
- lsFiles
- fs.readdir
-Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Function lsFiles
Lists files in the specified directory path, filtering by a regular +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Function lsFiles
Lists files in the specified directory path, filtering by a regular expression pattern.
The returned entries are configurable using the additional options, such as listing recursively to subdirectories, and filter specific file and/or @@ -197,10 +197,10 @@
See
- lsDirs
- fs.readdir
-Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Function ls
Lists files and/or directories in a specified directory path, filtering by a +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Function ls
Lists files and/or directories in a specified directory path, filtering by a regular expression pattern.
The returned entries are configurable using the additional options, such as listing recursively to subdirectories, and filter specific file and/or @@ -188,10 +188,10 @@
Returns Promise<LsResult>
A promise that resolves with an array of string representing the entries result excluding
-'.'and'..'or an empty array ([]) if any files and directories does not match with the specified filter options.Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Function lsDirs
Lists files in the specified directory path, filtering by a regular +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Function lsDirs
Lists files in the specified directory path, filtering by a regular expression pattern.
The returned entries are configurable using the additional options, such as listing recursively to subdirectories, and filter specific file and/or @@ -184,10 +184,10 @@
Returns Promise<LsResult>
A promise that resolves with an array of string representing the entries result excluding
-'.'and'..'or an empty array ([]) if any files and directories does not match with the specified filter options.Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Function lsFiles
Lists files in the specified directory path, filtering by a regular +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Function lsFiles
Lists files in the specified directory path, filtering by a regular expression pattern.
The returned entries are configurable using the additional options, such as listing recursively to subdirectories, and filter specific file and/or @@ -184,10 +184,10 @@
Returns Promise<LsResult>
A promise that resolves with an array of string representing the entries result excluding
-'.'and'..'or an empty array ([]) if any files and directories does not match with the specified filter options.Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0LSFND - v1.0.0
LSFND
- Preparing search index...
- The search index is not available
LSFND - v1.1.0LSFND - v1.1.0
LSFND
This library's primary benefit is that every implemented API runs asynchronously, guaranteeing that they will NEVER disrupt the execution of any other processes.
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Interface BuildPropConfig
Interface representing the configuration options for the build process.
+- Preparing search index...
- The search index is not available
LSFND - v1.1.0Interface BuildPropConfig
Interface representing the configuration options for the build process.
Since
0.1.0
-rootDir: string;
outDir: string;
tsconfig: string;
minify: MinifyConfig;
}
Index
Properties
rootDir: string;
outDir: string;
tsconfig: string;
minify: MinifyConfig;
}
Index
Properties
Properties
root
The root directory of the project from where the build process starts. This path should be a string representing a valid file system path.
-out
The output directory where the build process will place generated files. +
out
The output directory where the build process will place generated files. This path should be a string representing a valid file system path.
-tsconfig
The path to the
tsconfig.jsonfile that will be used during the build process. +tsconfig
The path to the
-tsconfig.jsonfile that will be used during the build process. This path should be a string representing a valid file system path relative to the rootDir.minify
Configuration options for minification process.
-Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
+
minify
Configuration options for minification process.
+Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Interface MinifyConfig
Interface representing the configuration options for minification within the +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Interface MinifyConfig
Interface representing the configuration options for minification within the build process.
Since
0.1.0
-files: string[];
}
Index
Properties
files: string[];
}
Index
Properties
Properties
files
A list of file paths (relative to the BuildPropConfig.rootDir) to be included during minification. Each element in the array should be a string representing a valid file system path.
-Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Interface DefaultLsOptions
Represents the default options type for the
ls*functions, used by +- Preparing search index...
- The search index is not available
LSFND - v1.1.0Interface DefaultLsOptions
Represents the default options type for the
ls*functions, used bydefaultLsOptions.Since
1.0.0
See
@@ -164,17 +164,17 @@
See
- ResolvedLsOptions
- defaultLsOptions
-encoding: "utf8";
recursive: false;
match: RegExp;
exclude: undefined;
rootDir: string | URL;
absolute: false;
basename: false;
}
Index
Properties
encoding: "utf8";
recursive: false;
match: RegExp;
exclude: undefined;
rootDir: string | URL;
absolute: false;
basename: false;
}
Index
Properties
Properties
ReadonlyencodingReadonlyrecursiveReadonlymatchReadonlyexcludeReadonlyrootReadonlyabsoluteReadonlybasenameSettings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
+
Properties
ReadonlyencodingReadonlyrecursiveReadonlymatchReadonlyexcludeReadonlyrootReadonlyabsoluteReadonlybasenameSettings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Interface LsOptions
This interface defines the optional configuration options that can be passed +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Interface LsOptions
This interface defines the optional configuration options that can be passed to every
ls*functions. These options control the behavior of the directory listing.Since
0.1.0
-encoding?: BufferEncoding;
recursive?: boolean;
match?: string | RegExp;
exclude?: string | RegExp;
rootDir?: string | URL;
absolute?: boolean;
basename?: boolean;
}
Index
Properties
encoding?: BufferEncoding;
recursive?: boolean;
match?: string | RegExp;
exclude?: string | RegExp;
rootDir?: string | URL;
absolute?: boolean;
basename?: boolean;
}
Index
Properties
Default Value
'utf8'Since
0.1.0
-OptionalrecursiveA boolean flag indicating whether to include subdirectories in the listing.
+OptionalrecursiveA boolean flag indicating whether to include subdirectories in the listing.
Default Value
falseSince
0.1.0
-OptionalmatchA regular expression or string pattern used to filter the listed entries. +
OptionalmatchA regular expression or string pattern used to filter the listed entries. Only entries matching the pattern will be included in the results.
Default Value
/.+/(match all files)Since
0.1.0
-OptionalexcludeA regular expression or string pattern used to exclude entries from the +
OptionalexcludeA regular expression or string pattern used to exclude entries from the listing. Any entries matching this pattern will be filtered out of the results, even if they match the match pattern.
Default Value
undefinedSince
0.1.0
-OptionalrootA string path representing the root directory to resolve the results to +
OptionalrootA string path representing the root directory to resolve the results to relative paths.
This option will be ignored if either one of the
absoluteorbasenameoption are enabled, this is due to their @@ -190,7 +190,7 @@Since
0.1.0
options.Default Value
'.'orprocess.cwd()Since
1.0.0
-OptionalabsoluteDetermines whether to return absolute paths for all entries.
+OptionalabsoluteDetermines whether to return absolute paths for all entries.
When enabled (i.e., set to
@@ -216,7 +216,7 @@true), each entry of the returned results will be an absolute path. Otherwise, paths will be relative to the directory specified in therootDirfield.Since
1.0.0
Default Value
falseSince
1.0.0
See
rootDir
-OptionalbasenameWhether to make the returned result paths only have their basenames, trimming any +
OptionalbasenameWhether to make the returned result paths only have their basenames, trimming any directories behind the path separator (i.e.,
\\in Windows, and/in POSIX).When set to
true, the returned paths will only include the file and/or directory names itself. This can be useful if you need only the names while @@ -240,10 +240,10 @@See
Default Value
falseSince
1.0.0
See
rootDir
-Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Interface LsTypesInterface
ReadonlyInterface defining the lsTypes enum with string literal keys +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Interface LsTypesInterface
ReadonlyInterface defining the lsTypes enum with string literal keys representing different file types and their corresponding numeric values.
Since
0.1.0
-LS_A: 1;
LS_D: 2;
LS_F: 4;
}
Index
Properties
LS_A: 1;
LS_D: 2;
LS_F: 4;
}
Index
Properties
Properties
ReadonlyLS_Represents an option to include all file types.
Default Value
-0b01 << 0b00(0b01|0o01|0x01|1)ReadonlyLS_Represents an option to include only the directory type.
+ReadonlyLS_Represents an option to include only the directory type.
Default Value
-0b01 << 0b01(0b10|0o02|0x02|2)ReadonlyLS_Represents an option to include only the file type.
+ReadonlyLS_Represents an option to include only the file type.
Default Value
-0b01 << 0b10(0b100|0o04|0x04|4)Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Module build.prop
Type definitions for
+build.prop.*jsconfiguration file.Project: lsfnd (https://github.com/mitsuki31/lsfnd.git)
Definitions by: Ryuu Mitsuki (https://github.com/mitsuki31)
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Module build.prop
Type definitions for
build.prop.*jsconfiguration file.Project: lsfnd (https://github.com/mitsuki31/lsfnd.git)
Definitions by: Ryuu Mitsuki (https://github.com/mitsuki31)
Author
Ryuu Mitsuki (https://github.com/mitsuki31)
Since
0.1.0
License
MIT
-Index
Interfaces
Index
Interfaces
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Module lsTypes
A module contains only a lsTypes enum, which is used by ls +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Module lsTypes
A module contains only a lsTypes enum, which is used by ls function to specify type of the returned results.
Copyright (c) 2024 Ryuu Mitsuki. All rights reserved.
Author
Ryuu Mitsuki (https://github.com/mitsuki31)
Since
0.1.0
License
MIT
See
lsTypes
-Index
Enumerations
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
+
Index
Enumerations
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Module lsfnd
A module that offers some functions to read and list files and/or directories +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Module lsfnd
A module that offers some functions to read and list files and/or directories in a specified directory with support filtering using regular expression pattern.
Copyright (c) 2024 Ryuu Mitsuki. All rights reserved.
Author
Ryuu Mitsuki (https://github.com/mitsuki31)
Since
0.1.0
License
MIT
-Index
Variables
Index
Variables
Functions
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Module types
Type definitions for
+lsfndpackage.Project: lsfnd (https://github.com/mitsuki31/lsfnd.git)
Definitions by: Ryuu Mitsuki (https://github.com/mitsuki31)
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Module types
Type definitions for
lsfndpackage.Project: lsfnd (https://github.com/mitsuki31/lsfnd.git)
Definitions by: Ryuu Mitsuki (https://github.com/mitsuki31)
Copyright (c) 2024 Ryuu Mitsuki. All rights reserved.
Author
Ryuu Mitsuki (https://github.com/mitsuki31)
Since
0.1.0
License
MIT
-Index
Interfaces
Index
Interfaces
Type Aliases
License
MIT
Functions
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Type alias LsEntries
This type alias represents an array of StringPath. It is typically used to +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Type alias LsEntries
This type alias represents an array of StringPath. It is typically used to represent the list of file and/or directory entries returned by the
ls*functions. Each entry in the array represents the path of a file or directory within the listed directory.Since
0.1.0
-Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Type alias LsResult
This type alias represents the possible return values of the
ls*functions. +- Preparing search index...
- The search index is not available
LSFND - v1.1.0Type alias LsResult
This type alias represents the possible return values of the
ls*functions. It can be either a LsEntries array containing the list of file paths, ornullto indicate an error.Since
0.1.0
-Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Type alias LsTypes
A combination union types containing all possible values used to specify the +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Type alias LsTypes
A combination union types containing all possible values used to specify the returned results on ls function.
Since
1.0.0
See
lsTypes
-Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Type alias LsTypesKeys
Type representing all possible keys of the lsTypes enum.
+- Preparing search index...
- The search index is not available
LSFND - v1.1.0Type alias LsTypesKeys
Type representing all possible keys of the lsTypes enum.
Since
0.1.0
See
LsTypesInterface
-Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Type alias LsTypesValues
Type representing all possible values of the lsTypes enum.
+- Preparing search index...
- The search index is not available
LSFND - v1.1.0Type alias LsTypesValues
Type representing all possible values of the lsTypes enum.
Since
0.1.0
See
- LsTypesInterface
- LsTypesKeys
-Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Type alias ResolvedLsOptions
[T in keyof LsOptions]-?: T extends "exclude"
? NonNullable<LsOptions[T]> | undefined
: NonNullable<LsOptions[T]>
}
Represents resolved options type for the
ls*functions, where all properties are +- Preparing search index...
- The search index is not available
LSFND - v1.1.0Type alias ResolvedLsOptions
[T in keyof LsOptions]-?: T extends "exclude"
? NonNullable<LsOptions[T]> | undefined
: NonNullable<LsOptions[T]>
}
Represents resolved options type for the
ls*functions, where all properties are required and bothnullandundefinedvalues are omitted, except for theexcludeproperty which keeps theundefinedtype.Since
1.0.0
@@ -164,10 +164,10 @@See
- LsOptions
- DefaultLsOptions
-Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Type alias StringPath
A type representing the string path.
+- Preparing search index...
- The search index is not available
LSFND - v1.1.0Type alias StringPath
A type representing the string path.
Since
1.0.0
-Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Variable defaultLsOptions
ConstAn object containing all default values of
+LsOptionstype.- Preparing search index...
- The search index is not available
LSFND - v1.1.0Variable defaultLsOptions
ConstAn object containing all default values of
LsOptionstype.Since
1.0.0
See
- DefaultLsOptions
- LsOptions
-Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
- Preparing search index...
- The search index is not available
LSFND - v1.0.0Variable lsTypes
ConstThis enumeration defines the different types of listings supported by +
- Preparing search index...
- The search index is not available
LSFND - v1.1.0Variable lsTypes
ConstThis enumeration defines the different types of listings supported by the ls function. It specifies which file system entries should be included in the results.
See
For more details, refer to lsTypes enum documentation.
-Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12
+
Settings
Member Visibility
Theme
Generated using TypeDoc v0.25.12