Class Main

Main utility class providing methods for project structure and path resolution.

Index

Constructors

Properties

Accessors

findPackageJson projectRoot instance

Methods

moduleTypePathResolver packageResolver pathResolver

Constructors

`Private` constructor

new Main(): Tools.PathManager.Main
Private
Private constructor to enforce singleton pattern.

Returns Tools.PathManager.Main
- Defined in lib/tools/path-manager/path-manager.main.ts:35

Properties

`Static` `Private` `Optional` memo

memo?: Tools.PathManager.Main

Accessors

`Private` findPackageJson

get findPackageJson(): FindLike
Private
Gets the function for finding package.json based on the environment.

Returns FindLike
- Defined in lib/tools/path-manager/path-manager.main.ts:63

projectRoot

get projectRoot(): string
Gets the root path of the project by finding the nearest package.json.

Returns string
Throws
Throws an error if no package.json is found.
- Defined in lib/tools/path-manager/path-manager.main.ts:44

`Static` instance

get instance(): Tools.PathManager.Main
Gets the singleton instance of the class.

Returns Tools.PathManager.Main
Static
- Defined in lib/tools/path-manager/path-manager.main.ts:22

Methods

moduleTypePathResolver

moduleTypePathResolver(filePath): string
Resolves a file or folder path based on the module type (CJS or ESM).
Parameters
- filePath: string
  The path to the file or folder.
Returns string
The resolved path based on the module type.
- Defined in lib/tools/path-manager/path-manager.main.ts:85

packageResolver

packageResolver(fileOrFolderPath): string
Resolves a file or folder path relative to the current package, considering development or node_modules usage.
Parameters
- fileOrFolderPath: string
  The path to the file or folder starting from the lib folder.
Returns string
The resolved path.
- Defined in lib/tools/path-manager/path-manager.main.ts:95

pathResolver

pathResolver(fileOrFolderPath): string
Resolves a file or folder path relative to the project root.
Parameters
- fileOrFolderPath: string
  The path to the file or folder.
Returns string
The resolved path.
- Defined in lib/tools/path-manager/path-manager.main.ts:75

Generated using TypeDoc