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

Enumeration lsTypesReadonly

This enumeration defines the different types of listings supported by +

Enumeration lsTypesReadonly

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.

Since

0.1.0

See

ls

-

Enumeration Members

LS_A +

Enumeration Members

LS_A LS_D LS_F

Enumeration Members

LS_A

LS_A: 1

This option lists both regular files and directories in the output. You can also use other number types for alias, like:

LS_A: 0b01 | 0o01 | 0x01  // Each equivalent to 1
-

LS_D

LS_D: 2

This option filters the output to include only directory entries. +

LS_D

LS_D: 2

This option filters the output to include only directory entries. You can also use other number types for alias, like:

LS_D: 0b10 | 0o02 | 0x02  // Each equivalent to 2
-

LS_F

LS_F: 4

This option filters the output to include only regular files (non-directories). +

LS_F

LS_F: 4

This option filters the output to include only regular files (non-directories). You can also use other number types for alias, like:

LS_F: 0b100 | 0o04 | 0x04  // Each equivalent to 4
-

Settings

Member Visibility

Theme

On This Page

LS_ALS_DLS_F

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

On This Page

LS_ALS_DLS_F

Generated using TypeDoc v0.25.12

Function ls

  • ls(dirpath, options?, type?): Promise<LsResult>

  • Lists files and/or directories in a specified directory path, filtering by a +

    Function ls

    • ls(dirpath, options?, type?): Promise<LsResult>

    • 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

      -

    Settings

    Member Visibility

    Theme

    On This Page

    1.0.00.1.0

    Generated using TypeDoc v0.25.12
    +

Settings

Member Visibility

Theme

On This Page

1.0.00.1.0

Generated using TypeDoc v0.25.12

Function lsDirs

  • lsDirs(dirpath, options?): Promise<LsResult>

  • Lists files in the specified directory path, filtering by a regular +

    Function lsDirs

    • lsDirs(dirpath, options?): Promise<LsResult>

    • 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

      -

    Settings

    Member Visibility

    Theme

    On This Page

    1.0.00.1.0

    Generated using TypeDoc v0.25.12
    +

Settings

Member Visibility

Theme

On This Page

1.0.00.1.0

Generated using TypeDoc v0.25.12

Function lsFiles

  • lsFiles(dirpath, options?): Promise<LsResult>

  • Lists files in the specified directory path, filtering by a regular +

    Function lsFiles

    • lsFiles(dirpath, options?): Promise<LsResult>

    • 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

      -

    Settings

    Member Visibility

    Theme

    On This Page

    1.0.00.1.0

    Generated using TypeDoc v0.25.12
    +

Settings

Member Visibility

Theme

On This Page

1.0.00.1.0

Generated using TypeDoc v0.25.12

Function ls

  • ls(dirpath, options?, type?): Promise<LsResult>

  • Lists files and/or directories in a specified directory path, filtering by a +

    Function ls

    • ls(dirpath, options?, type?): Promise<LsResult>

    • 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

1.0.00.1.0

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

On This Page

1.0.00.1.0

Generated using TypeDoc v0.25.12

Function lsDirs

  • lsDirs(dirpath, options?): Promise<LsResult>

  • Lists files in the specified directory path, filtering by a regular +

    Function lsDirs

    • lsDirs(dirpath, options?): Promise<LsResult>

    • 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

1.0.00.1.0

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

On This Page

1.0.00.1.0

Generated using TypeDoc v0.25.12

Function lsFiles

  • lsFiles(dirpath, options?): Promise<LsResult>

  • Lists files in the specified directory path, filtering by a regular +

    Function lsFiles

    • lsFiles(dirpath, options?): Promise<LsResult>

    • 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

1.0.00.1.0

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

On This Page

1.0.00.1.0

Generated using TypeDoc v0.25.12

LSFND - v1.0.0

LSFND

Version +

LSFND - v1.1.0

LSFND

Version Min. Node Bundle size (minified)
Test CI @@ -169,7 +169,7 @@

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.

@@ -378,10 +378,10 @@

License

This project is licensed under the terms of MIT license.

-

Settings

Member Visibility

Theme

On This Page

LSFND

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

On This Page

LSFND

Generated using TypeDoc v0.25.12
+ \ No newline at end of file diff --git a/interfaces/build_prop.BuildPropConfig.html b/interfaces/build_prop.BuildPropConfig.html index 8d7e7cd..11f6b47 100644 --- a/interfaces/build_prop.BuildPropConfig.html +++ b/interfaces/build_prop.BuildPropConfig.html @@ -1,4 +1,4 @@ -BuildPropConfig | LSFND - v1.0.0

Interface BuildPropConfig

Interface representing the configuration options for the build process.

+

Interface BuildPropConfig

Interface representing the configuration options for the build process.

Since

0.1.0

-
interface BuildPropConfig {
    rootDir: string;
    outDir: string;
    tsconfig: string;
    minify: MinifyConfig;
}

Properties

rootDir +
interface BuildPropConfig {
    rootDir: string;
    outDir: string;
    tsconfig: string;
    minify: MinifyConfig;
}

Properties

rootDir outDir tsconfig minify

Properties

rootDir

rootDir: string

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.

-

minify

minify: MinifyConfig

Configuration options for minification process.

-

Settings

Member Visibility

Theme

On This Page

rootDiroutDirtsconfigminify

Generated using TypeDoc v0.25.12
+

minify

minify: MinifyConfig

Configuration options for minification process.

+

Settings

Member Visibility

Theme

On This Page

rootDiroutDirtsconfigminify

Generated using TypeDoc v0.25.12

Interface MinifyConfig

Interface representing the configuration options for minification within the +

Interface MinifyConfig

Interface representing the configuration options for minification within the build process.

Since

0.1.0

-
interface MinifyConfig {
    files: string[];
}

Properties

files +
interface MinifyConfig {
    files: string[];
}

Properties

files

Properties

files

files: string[]

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

files

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

On This Page

files

Generated using TypeDoc v0.25.12

Interface DefaultLsOptions

Represents the default options type for the ls* functions, used by +

Interface DefaultLsOptions

Represents the default options type for the ls* functions, used by defaultLsOptions.

Since

1.0.0

See

interface DefaultLsOptions {
    encoding: "utf8";
    recursive: false;
    match: RegExp;
    exclude: undefined;
    rootDir: string | URL;
    absolute: false;
    basename: false;
}

Properties

encoding +
interface DefaultLsOptions {
    encoding: "utf8";
    recursive: false;
    match: RegExp;
    exclude: undefined;
    rootDir: string | URL;
    absolute: false;
    basename: false;
}

Properties

encoding recursive match exclude rootDir absolute basename -

Properties

Readonly encoding

encoding: "utf8"

Readonly recursive

recursive: false

Readonly match

match: RegExp

Readonly exclude

exclude: undefined

Readonly rootDir

rootDir: string | URL

Readonly absolute

absolute: false

Readonly basename

basename: false

Settings

Member Visibility

Theme

On This Page

encodingrecursivematchexcluderootDirabsolutebasename

Generated using TypeDoc v0.25.12
+

Properties

Readonly encoding

encoding: "utf8"

Readonly recursive

recursive: false

Readonly match

match: RegExp

Readonly exclude

exclude: undefined

Readonly rootDir

rootDir: string | URL

Readonly absolute

absolute: false

Readonly basename

basename: false

Settings

Member Visibility

Theme

On This Page

encodingrecursivematchexcluderootDirabsolutebasename

Generated using TypeDoc v0.25.12

Interface LsOptions

This interface defines the optional configuration options that can be passed +

Interface 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

-
interface LsOptions {
    encoding?: BufferEncoding;
    recursive?: boolean;
    match?: string | RegExp;
    exclude?: string | RegExp;
    rootDir?: string | URL;
    absolute?: boolean;
    basename?: boolean;
}

Properties

encoding? +
interface LsOptions {
    encoding?: BufferEncoding;
    recursive?: boolean;
    match?: string | RegExp;
    exclude?: string | RegExp;
    rootDir?: string | URL;
    absolute?: boolean;
    basename?: boolean;
}

Properties

encoding? recursive? match? exclude? @@ -170,19 +170,19 @@ returned entries.

Default Value

'utf8'

Since

0.1.0

-

Optional recursive

recursive?: boolean

A boolean flag indicating whether to include subdirectories in the listing.

+

Optional recursive

recursive?: boolean

A boolean flag indicating whether to include subdirectories in the listing.

Default Value

false

Since

0.1.0

-

Optional match

match?: string | RegExp

A regular expression or string pattern used to filter the listed entries. +

Optional match

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

-

Optional exclude

exclude?: string | RegExp

A regular expression or string pattern used to exclude entries from the +

Optional exclude

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

-

Optional rootDir

rootDir?: string | URL

A string path representing the root directory to resolve the results to +

Optional rootDir

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

-

Optional absolute

absolute?: boolean

Determines whether to return absolute paths for all entries.

+

Optional absolute

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.

@@ -216,7 +216,7 @@

Since

1.0.0

Default Value

false

Since

1.0.0

See

rootDir

-

Optional basename

basename?: boolean

Whether to make the returned result paths only have their basenames, trimming any +

Optional basename

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 @@

See

Default Value

false

Since

1.0.0

See

rootDir

-

Settings

Member Visibility

Theme

On This Page

encodingrecursivematchexcluderootDirabsolutebasename

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

On This Page

encodingrecursivematchexcluderootDirabsolutebasename

Generated using TypeDoc v0.25.12

Interface LsTypesInterfaceReadonly

Interface defining the lsTypes enum with string literal keys +

Interface LsTypesInterfaceReadonly

Interface defining the lsTypes enum with string literal keys representing different file types and their corresponding numeric values.

Since

0.1.0

-
interface LsTypesInterface {
    LS_A: 1;
    LS_D: 2;
    LS_F: 4;
}

Properties

LS_A +
interface LsTypesInterface {
    LS_A: 1;
    LS_D: 2;
    LS_F: 4;
}

Properties

LS_A LS_D LS_F

Properties

Readonly LS_A

LS_A: 1

Represents an option to include all file types.

Default Value

0b01 << 0b00 (0b01 | 0o01 | 0x01 | 1)

-

Readonly LS_D

LS_D: 2

Represents an option to include only the directory type.

+

Readonly LS_D

LS_D: 2

Represents an option to include only the directory type.

Default Value

0b01 << 0b01 (0b10 | 0o02 | 0x02 | 2)

-

Readonly LS_F

LS_F: 4

Represents an option to include only the file type.

+

Readonly LS_F

LS_F: 4

Represents an option to include only the file type.

Default Value

0b01 << 0b10 (0b100 | 0o04 | 0x04 | 4)

-

Settings

Member Visibility

Theme

On This Page

LS_ALS_DLS_F

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

On This Page

LS_ALS_DLS_F

Generated using TypeDoc v0.25.12

Module build.prop

Type definitions for build.prop.*js configuration file.
Project: lsfnd (https://github.com/mitsuki31/lsfnd.git)
Definitions by: Ryuu Mitsuki (https://github.com/mitsuki31)

+

Module build.prop

Type definitions for build.prop.*js configuration 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

BuildPropConfig +

Index

Interfaces

BuildPropConfig MinifyConfig -

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12

Module lsTypes

A module contains only a lsTypes enum, which is used by ls +

Module 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

lsTypes -

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12
+

Index

Enumerations

lsTypes +

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12

Module lsfnd

A module that offers some functions to read and list files and/or directories +

Module 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

defaultLsOptions +

Index

Variables

defaultLsOptions

Functions

ls lsFiles lsDirs -

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12

Module types

Type definitions for lsfnd package.
Project: lsfnd (https://github.com/mitsuki31/lsfnd.git)
Definitions by: Ryuu Mitsuki (https://github.com/mitsuki31)

+

Module types

Type definitions for lsfnd package.
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

LsTypesInterface +

Index

Interfaces

LsTypesInterface LsOptions DefaultLsOptions

Type Aliases

StringPath @@ -175,10 +175,10 @@

License

MIT

Functions

ls lsFiles lsDirs -

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12

Type alias LsEntries

LsEntries: StringPath[]

This type alias represents an array of StringPath. It is typically used to +

Type alias LsEntries

LsEntries: StringPath[]

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

Type alias LsResult

LsResult: LsEntries | null

This type alias represents the possible return values of the ls* functions. +

Type alias LsResult

LsResult: LsEntries | null

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.

Since

0.1.0

-

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12

Type alias LsTypes

LsTypes: LsTypesKeys | LsTypesValues

A combination union types containing all possible values used to specify the +

Type alias LsTypes

LsTypes: LsTypesKeys | LsTypesValues

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

Type alias LsTypesKeys

LsTypesKeys: keyof LsTypesInterface

Type representing all possible keys of the lsTypes enum.

+

Type alias LsTypesKeys

LsTypesKeys: keyof LsTypesInterface

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

Type alias LsTypesValues

LsTypesValues: keyof typeof LsTypesInterface

Type representing all possible values of the lsTypes enum.

+

Type alias LsTypesValues

LsTypesValues: keyof typeof LsTypesInterface

Type representing all possible values of the lsTypes enum.

Since

0.1.0

See

-

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12

Type alias ResolvedLsOptions

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 +

Type alias ResolvedLsOptions

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.

Since

1.0.0

@@ -164,10 +164,10 @@

See

-

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12

Type alias StringPath

StringPath: string

A type representing the string path.

+

Type alias StringPath

StringPath: string

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

Variable defaultLsOptionsConst

defaultLsOptions: DefaultLsOptions = ...

An object containing all default values of LsOptions type.

+

Variable defaultLsOptionsConst

defaultLsOptions: DefaultLsOptions = ...

An object containing all default values of LsOptions type.

Since

1.0.0

See

-

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12

Variable lsTypesConst

lsTypes: Record<LsTypesKeys, LsTypesValues> & Record<LsTypesValues, LsTypesKeys>

This enumeration defines the different types of listings supported by +

Variable lsTypesConst

lsTypes: Record<LsTypesKeys, LsTypesValues> & Record<LsTypesValues, LsTypesKeys>

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.

-

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12
+

Settings

Member Visibility

Theme

Generated using TypeDoc v0.25.12