@xan105/fs

alias unlink(path: string): Promise

alias deleteFile(path: string): Promise

alias rmdir(path: string): Promise

Nuke the target 🚀💥.

$3

Hash specified file (use stream). algo defaults to "sha256".



$3

Create, change and modify timestamps of a file.

$3

List directory contents.

⚙️ Options:

- verbose: boolean (false)
- recursive: boolean (false)
- absolute: boolean false)

Return absolute or relative path

- follow: boolean (false)

Whether or not to follow symlink

- normalize: boolean (false)

Whether or not to normalize path seperator to "/"

- ignore:

+ dir: boolean (false)
+ file: boolean (false)
+ symlink: boolean (false)
+ socket: boolean (false)
+ dot: boolean (true)

- filter: string[] (empty)
- whitelist: boolean (false)

Turn the filter list into a whitelist

- ext: string[] (empty)

Allowed file extension

- pattern: RegExp (none)

Return value:

If verbose is true returns a detailed list as

`ts
[
{
name: string, //file name
path: string, //path of file
link?: string | undefined //symlink target
},
...
]
`

Otherwise string[] (path of file)

#### compareFile(a: string, b:string, algo?: string): Promise

Compare files to determine if they are identical.

Comparison is by default done with "sha1" algo (cf: hashFile()) unless files size don't match.

$3

#### resolve(path: string): string

Resolve fileURL and path if necessary.

#### dirname(path: string): string

Handles path and fileURL.

#### normalize(path: string, win32?: boolean): string

replace every \\ with /


When win32 is set to true (default is false)

replace every / with \\

#### isRoot(path: string): boolean
#### isBasename(path: string): boolean

$3

#### sanitizeFileName(string: string): string
#### setHidden(path: string): Promise
#### removeHidden(path: string): Promise
#### setReadOnly(path: string): Promise
#### removeReadOnly(path: string): Promise
#### isHidden(path: string): Promise
#### isReadOnly(path: string): Promise
#### isHiddenAndReadOnly(path: string): Promise`