KavenUtility.FileSystem | kaven-utils

Index

Functions

Functions

CopyDirectory

CopyDirectory(src: string, dest: string): Promise<void>

- Defined in src/KavenUtility.FileSystem.ts:229
since

3.0.0

version

2021-08-06

Parameters
- src: string
- dest: string
Returns Promise<void>

CopyFile

CopyFile(src: string, dest: string): Promise<void>

- Defined in src/KavenUtility.FileSystem.ts:189
since

3.0.0

version

2021-09-13

Parameters
- src: string
- dest: string
Returns Promise<void>

CopyFileOrDirectory

CopyFileOrDirectory(src: string, dest: string): Promise<void>

- Defined in src/KavenUtility.FileSystem.ts:260
since

3.0.0

version

2021-08-06

Parameters
- src: string
- dest: string
Returns Promise<void>

CopyFileSync

CopyFileSync(src: string, dest: string): void

- Defined in src/KavenUtility.FileSystem.ts:217
since

1.0.5

version

2021-08-06

Parameters
- src: string
- dest: string
Returns void

CopyToDirectory

CopyToDirectory(files: string[], destDir: string): Promise<void>

- Defined in src/KavenUtility.FileSystem.ts:280
since

3.0.0

version

2021-08-06

Parameters
- files: string[]
- destDir: string
Returns Promise<void>

DeleteDirectory

DeleteDirectory(path: string): Promise<void>

- Defined in src/KavenUtility.FileSystem.ts:124
since

3.0.0

version

2021-11-20

Parameters
- path: string
Returns Promise<void>

DeleteFile

DeleteFile(path: string): Promise<string | undefined>

- Defined in src/KavenUtility.FileSystem.ts:107
since

3.0.0

version

2021-11-20

Parameters
- path: string
Returns Promise<string | undefined>

DeleteFileOrDirectory

DeleteFileOrDirectory(...paths: string[]): Promise<void>

- Defined in src/KavenUtility.FileSystem.ts:302
since

1.1.21

version

2021-08-06

Parameters
- Rest ...paths: string[]
Returns Promise<void>

GetFileExtension

GetFileExtension(fileName: string, trimDot?: boolean, toLowerCase?: boolean): string

- Defined in src/KavenUtility.FileSystem.ts:323
since

1.0.5

version

2021-12-07

Parameters
- fileName: string
- trimDot: boolean = false
- toLowerCase: boolean = false
Returns string

GetFileName

GetFileName(fileName: string): string

- Defined in src/KavenUtility.FileSystem.ts:348
version

2018-11-06

since

1.0.5

Parameters
- fileName: string
Returns string

GetFileSize

GetFileSize(path: string, baseOn1024?: boolean): Promise<undefined | string>

- Defined in src/KavenUtility.FileSystem.ts:91
since

3.0.0

version

2021-08-07

Parameters
- path: string
- Optional baseOn1024: boolean
Returns Promise<undefined | string>

GetFileSizeInBytes

GetFileSizeInBytes(path: string): Promise<undefined | number>

- Defined in src/KavenUtility.FileSystem.ts:78
since

1.0.9

version

2021-08-06

Parameters
- path: string
Returns Promise<undefined | number>

GetFileStats

GetFileStats(path: string): Promise<Stats | undefined>

- Defined in src/KavenUtility.FileSystem.ts:43
since

3.0.0

version

2021-08-06

Parameters
- path: string
Returns Promise<Stats | undefined>

IsDirectory

IsDirectory(path: string): Promise<boolean | undefined>

- Defined in src/KavenUtility.FileSystem.ts:67
since

1.0.5

version

2021-08-06

Parameters
- path: string
Returns Promise<boolean | undefined>

IsFile

IsFile(path: string): Promise<boolean | undefined>

- Defined in src/KavenUtility.FileSystem.ts:56
since

2.0.2

version

2021-08-06

Parameters
- path: string
Returns Promise<boolean | undefined>

IsPathExistSync

IsPathExistSync(...paths: string[]): boolean

- Defined in src/KavenUtility.FileSystem.ts:32
Simple wrap for existsSync

see

https://nodejs.org/docs/latest-v8.x/api/html#fs_fs_existssync_path

since

3.0.0

since

2021-08-06

Parameters
- Rest ...paths: string[]
Returns boolean

MakeDirectory

MakeDirectory(path: string): Promise<string>

- Defined in src/KavenUtility.FileSystem.ts:159
since

1.0.9

version

2021-08-06

Parameters
- path: string
Returns Promise<string>

Returns the directory path.

MakeDirectorySync

MakeDirectorySync(path: string): string

- Defined in src/KavenUtility.FileSystem.ts:174
since

1.0.9

version

2021-08-06

Parameters
- path: string
Returns string

Returns the directory path.

TruncateFile

TruncateFile(path: string, len?: number): Promise<void>

- Defined in src/KavenUtility.FileSystem.ts:206
since

3.0.0

version

2021-08-07

Parameters
- path: string
- Optional len: number
Returns Promise<void>

Generated using TypeDoc