External module "fs/index"

Index

Interfaces

Type aliases

Variables

MergeDeep

Type aliases

FastGlobEntryItem

FastGlobEntryItem: string | IFastGlobEntry

FastGlobOptions

FastGlobOptions: FastGlob.Options

TempFilePath

TempFilePath: string | false

Variables

Const MergeDeep

MergeDeep: any = require('merge-deep')

Functions

createDirectoryIfNeeded

createDirectoryIfNeeded(dir: string): Promise<boolean>

- Defined in fs/index.ts:68
Creates a directory (if needed).

Parameters
- dir: string
  
  The path of the directory to create.
Returns Promise<boolean>

The promise that indicates if directory has been created or not.

exists

exists(path: string | Buffer): Promise<boolean>

- Defined in fs/index.ts:87
Promise version of 'FS.exists()' function.

Parameters
- path: string | Buffer
  
  The path.
Returns Promise<boolean>

The promise that indicates if path exists or not.

fastGlob

fastGlob(patterns: string | string[], opts?: FastGlob.Options): Promise<FastGlobEntryItem[]>

- Defined in fs/index.ts:109
Fast version of 'node-glob'.

Parameters
- patterns: string | string[]
  
  One or more patterns to search for.
- Optional opts: FastGlob.Options
Returns Promise<FastGlobEntryItem[]>

Promise with the found files / directories.

fastGlobSync

fastGlobSync(patterns: string | string[], opts?: FastGlob.Options): FastGlobEntryItem[]

- Defined in fs/index.ts:121
Fast version of 'node-glob' (sync).

Parameters
- patterns: string | string[]
  
  One or more patterns to search for.
- Optional opts: FastGlob.Options
Returns FastGlobEntryItem[]

The found files / directories.

glob

glob(patterns: string | string[], opts?: Glob.IOptions): Promise<string[]>

- Defined in fs/index.ts:133
Promise version of 'Glob()' function.

Parameters
- patterns: string | string[]
  
  One or more patterns.
- Optional opts: Glob.IOptions
Returns Promise<string[]>

The promise with the matches.

globSync

globSync(patterns: string | string[], opts?: Glob.IOptions): string[]

- Defined in fs/index.ts:181
Multi pattern version of 'Glob.sync()' function.

Parameters
- patterns: string | string[]
  
  One or more patterns.
- Optional opts: Glob.IOptions
Returns string[]

The matches.

invokeForStats

invokeForStats<TResult>(path: string, useLSTAT: any, func: function, defaultValue?: TResult): Promise<TResult>

- Defined in fs/index.ts:199
Type parameters
- TResult
Parameters
- path: string
- useLSTAT: any
- func: function
  - - (stats: Stats): TResult
    - Parameters
      - stats: Stats
      Returns TResult
- Optional defaultValue: TResult
Returns Promise<TResult>

invokeForStatsSync

invokeForStatsSync<TResult>(path: string, useLSTAT: any, func: function, defaultValue?: TResult): TResult

- Defined in fs/index.ts:219
Type parameters
- TResult
Parameters
- path: string
- useLSTAT: any
- func: function
  - - (stats: Stats): TResult
    - Parameters
      - stats: Stats
      Returns TResult
- Optional defaultValue: TResult
Returns TResult

isBlockDevice

isBlockDevice(path: string, useLSTAT?: boolean): Promise<boolean>

- Defined in fs/index.ts:247
Checks if a path exists and is a block device.

Parameters
- path: string
  
  The path to check.
- Default value useLSTAT: boolean = true
Returns Promise<boolean>

The promise with the value that indicates if condition matches or not.

isBlockDeviceSync

isBlockDeviceSync(path: string, useLSTAT?: boolean): boolean

- Defined in fs/index.ts:263
Checks if a path exists and is a block device.

Parameters
- path: string
  
  The path to check.
- Default value useLSTAT: boolean = true
Returns boolean

A value that indicates if condition matches or not.

isCharacterDevice

isCharacterDevice(path: string, useLSTAT?: boolean): Promise<boolean>

- Defined in fs/index.ts:279
Checks if a path exists and is a character device.

Parameters
- path: string
  
  The path to check.
- Default value useLSTAT: boolean = true
Returns Promise<boolean>

The promise with the value that indicates if condition matches or not.

isCharacterDeviceSync

isCharacterDeviceSync(path: string, useLSTAT?: boolean): boolean

- Defined in fs/index.ts:295
Checks if a path exists and is a character device.

Parameters
- path: string
  
  The path to check.
- Default value useLSTAT: boolean = true
Returns boolean

A value that indicates if condition matches or not.

isDirectory

isDirectory(path: string, useLSTAT?: boolean): Promise<boolean>

- Defined in fs/index.ts:311
Checks if a path exists and is a directory.

Parameters
- path: string
  
  The path to check.
- Default value useLSTAT: boolean = true
Returns Promise<boolean>

The promise with the value that indicates if condition matches or not.

isDirectorySync

isDirectorySync(path: string, useLSTAT?: boolean): boolean

- Defined in fs/index.ts:327
Checks if a path exists and is a directory.

Parameters
- path: string
  
  The path to check.
- Default value useLSTAT: boolean = true
Returns boolean

A value that indicates if condition matches or not.

isFIFO

isFIFO(path: string, useLSTAT?: boolean): Promise<boolean>

- Defined in fs/index.ts:343
Checks if a path exists and is FIFO.

Parameters
- path: string
  
  The path to check.
- Default value useLSTAT: boolean = true
Returns Promise<boolean>

The promise with the value that indicates if condition matches or not.

isFIFOSync

isFIFOSync(path: string, useLSTAT?: boolean): boolean

- Defined in fs/index.ts:359
Checks if a path exists and is FIFO.

Parameters
- path: string
  
  The path to check.
- Default value useLSTAT: boolean = true
Returns boolean

A value that indicates if condition matches or not.

isFile

isFile(path: string, useLSTAT?: boolean): Promise<boolean>

- Defined in fs/index.ts:375
Checks if a path exists and is a file.

Parameters
- path: string
  
  The path to check.
- Default value useLSTAT: boolean = true
Returns Promise<boolean>

The promise with the value that indicates if condition matches or not.

isFileSync

isFileSync(path: string, useLSTAT?: boolean): boolean

- Defined in fs/index.ts:391
Checks if a path exists and is a file.

Parameters
- path: string
  
  The path to check.
- Default value useLSTAT: boolean = true
Returns boolean

A value that indicates if condition matches or not.

isSocket

isSocket(path: string, useLSTAT?: boolean): Promise<boolean>

- Defined in fs/index.ts:407
Checks if a path exists and is a socket.

Parameters
- path: string
  
  The path to check.
- Default value useLSTAT: boolean = true
Returns Promise<boolean>

The promise with the value that indicates if condition matches or not.

isSocketSync

isSocketSync(path: string, useLSTAT?: boolean): boolean

- Defined in fs/index.ts:423
Checks if a path exists and is a socket.

Parameters
- path: string
  
  The path to check.
- Default value useLSTAT: boolean = true
Returns boolean

A value that indicates if condition matches or not.

isSymbolicLink

isSymbolicLink(path: string, useLSTAT?: boolean): Promise<boolean>

- Defined in fs/index.ts:439
Checks if a path exists and is a symbolic link.

Parameters
- path: string
  
  The path to check.
- Default value useLSTAT: boolean = true
Returns Promise<boolean>

The promise with the value that indicates if condition matches or not.

isSymbolicLinkSync

isSymbolicLinkSync(path: string, useLSTAT?: boolean): boolean

- Defined in fs/index.ts:455
Checks if a path exists and is a symbolic link.

Parameters
- path: string
  
  The path to check.
- Default value useLSTAT: boolean = true
Returns boolean

A value that indicates if condition matches or not.

normalizeGlobOptions

normalizeGlobOptions(opts: Glob.IOptions, callerDefaultOpts: Glob.IOptions): Glob.IOptions

- Defined in fs/index.ts:463
Parameters
- opts: Glob.IOptions
- callerDefaultOpts: Glob.IOptions
Returns Glob.IOptions

normalizeTempFileOptions

normalizeTempFileOptions(opts: TempFileOptions): TempFileOptions

- Defined in fs/index.ts:478
Parameters
- opts: TempFileOptions
Returns TempFileOptions

size

size(path: string | Buffer, useLSTAT?: boolean): Promise<number>

- Defined in fs/index.ts:511
Returns the size of a file system element.

Parameters
- path: string | Buffer
  
  The path to the element.
- Default value useLSTAT: boolean = true
Returns Promise<number>

The promise with the size.

sizeSync

sizeSync(path: string | Buffer, useLSTAT?: boolean): number

- Defined in fs/index.ts:526
Returns the size of a file system element (sync).

Parameters
- path: string | Buffer
  
  The path to the element.
- Default value useLSTAT: boolean = true
Returns number

The size.

tempFile

tempFile<TResult>(action: function, opts?: TempFileOptions): Promise<TResult>

- Defined in fs/index.ts:541
Invokes an action for a temp file.

Type parameters
- TResult
Parameters
- action: function
  
  The action to invoke.
  - - (file: string): TResult | PromiseLike<TResult>
    - Parameters
      - file: string
      Returns TResult | PromiseLike<TResult>
- Optional opts: TempFileOptions
Returns Promise<TResult>

The promise with the result of the action.

tempFileSync

tempFileSync<TResult>(action: function, opts?: TempFileOptions): TResult

- Defined in fs/index.ts:608
Invokes an action for a temp file (sync).

Type parameters
- TResult
Parameters
- action: function
  
  The action to invoke.
  - - (file: string): TResult
    - Parameters
      - file: string
      Returns TResult
- Optional opts: TempFileOptions
Returns TResult

The result of the action.

toTmpSimpleOptions

toTmpSimpleOptions(opts: TempFileOptions): SimpleOptions

- Defined in fs/index.ts:591
Parameters
- opts: TempFileOptions
Returns SimpleOptions

tryUnlinkTempFile

tryUnlinkTempFile(file: TempFilePath, opts?: TempFileOptions): boolean

- Defined in fs/index.ts:625
Parameters
- file: TempFilePath
- Optional opts: TempFileOptions
Returns boolean

Generated using TypeDoc