Class CachedFileSystemAdapter

Decorate any existing file system with caching functionality; caches the write and stat operations towards the target file system. The methods readDirectory and findFiles are not cached and will be redirected to the base file system.

Hierarchy

FileSystem
- CachedFileSystemAdapter

Index

Constructors

constructor

new CachedFileSystemAdapter(innerFs): CachedFileSystemAdapter
Parameters
- innerFs: FileSystem
Returns CachedFileSystemAdapter
Overrides FileSystem.constructor
- Defined in packages/core/src/fs/cachedFileSystem.ts:10

Properties

`Private` `Readonly` innerFs

innerFs: FileSystem

Methods

appendFile

appendFile(path, body, options?): Promise<void>
Append data to an existing file to the file system, when the directory does not exists it will be created.
Parameters
- path: string
  
  path to the file to read
- body: string | Buffer
  
  body to write to the file
- Optional options: OutputOptions
  
  write options
Returns Promise<void>
Inherited from FileSystem.appendFile
- Defined in packages/core/src/fs/fileSystem.ts:266

clearCache

clearCache(): void
Returns void
- Defined in packages/core/src/fs/cachedFileSystem.ts:18

createDirectory

createDirectory(path): Promise<void>
Create a new directory at the specified path. No error should be thrown when the directory already exists.
Parameters
- path: string
  
  path to the directory to create
Returns Promise<void>
Overrides FileSystem.createDirectory
- Defined in packages/core/src/fs/cachedFileSystem.ts:46

find

find(globPatterns, options?): AsyncGenerator<string, any, unknown>
Find files and or folders matching the specified glob pattern as an async iterable. If the result is not iterated completely, the search is stopped. When you need the results as an array, use the Iterable.spreadAsync method to convert the async interable into an array.

By default the current working directory is used as the base directory for the search.

You can specify multiple glob patterns to match by specifying an array of glob patterns.

When a limit is specified, the search is stopped after the specified number of results is reached.

When a depth is specified, the search does not go deeper than the specified depth.
Parameters
- globPatterns: GlobPatterns
  
  Glob patterns to match
- Optional options: FindOptions
  
  find options
Returns AsyncGenerator<string, any, unknown>
Async iterable of matching files and or folders
Example
```
for await (const file of fs.find('*.ts')) {
    console.log(file);
}
```
Inherited from FileSystem.find
- Defined in packages/core/src/fs/fileSystem.ts:188

findFiles

findFiles(patterns): Promise<string[]>
Find files matching the specified glob pattern(s)
Parameters
- patterns: string | string[]
  
  Glob patterns to match files with
Returns Promise<string[]>
Overrides FileSystem.findFiles
- Defined in packages/core/src/fs/cachedFileSystem.ts:37

isDirectory

isDirectory(path): Promise<boolean>
Returns true if the path exists and is a folder, returns false when the path does not exists or is not a folder.
Parameters
- path: string
  
  Path to check
Returns Promise<boolean>
Inherited from FileSystem.isDirectory
- Defined in packages/core/src/fs/fileSystem.ts:127

isFile

isFile(path): Promise<boolean>
Returns true if the path exists and is a file, returns false when the path does not exists or is not a file.
Parameters
- path: string
  
  Path to check
Returns Promise<boolean>
Inherited from FileSystem.isFile
- Defined in packages/core/src/fs/fileSystem.ts:119

outputFile

outputFile(path, body?, options?): Promise<void>
Write a file to the file system, when the directory does not exists it will be created.
Parameters
- path: string
  
  path to the file to read
- Optional body: string | Buffer
  
  body to write to the file
- Optional options: OutputOptions
  
  write options
Returns Promise<void>
Inherited from FileSystem.outputFile
- Defined in packages/core/src/fs/fileSystem.ts:152

pathExists

pathExists(path): Promise<boolean>
Checks if the specified path exists on the file system
Parameters
- path: string
  
  Path to check
Returns Promise<boolean>
Inherited from FileSystem.pathExists
- Defined in packages/core/src/fs/fileSystem.ts:135

readDirectory

readDirectory(path): Promise<FileInfo[]>
Read the contents of a directs; returns an array with the files and folders contained in the specified directory.
Parameters
- path: string
  
  Directory
Returns Promise<FileInfo[]>
Overrides FileSystem.readDirectory
- Defined in packages/core/src/fs/cachedFileSystem.ts:32

readFile

readFile(fileName): Promise<Buffer>
Reads the specified file path into a NodeJS Buffer object
Parameters
- fileName: string
  
  path to the file to read
Returns Promise<Buffer>
Overrides FileSystem.readFile
- Defined in packages/core/src/fs/cachedFileSystem.ts:22

readFileAsString

readFileAsString(fileName, encoding?): Promise<string>
Read a file and returns the file body as String
Parameters
- fileName: string
- encoding: BufferEncoding = 'utf-8'
Returns Promise<string>
Overrides FileSystem.readFileAsString
- Defined in packages/core/src/fs/cachedFileSystem.ts:14

stat

stat(path, options?): Promise<undefined | FileStat>
Get file statistics; returns undefined when the file does not exists
Parameters
- path: string
  
  Path to check
- Optional options: StatsOptions
Returns Promise<undefined | FileStat>
Overrides FileSystem.stat
- Defined in packages/core/src/fs/cachedFileSystem.ts:27

writeFile

writeFile(path, data, options?): Promise<void>
Write a file to the file system, when the directory does not exists it will be created.
Parameters
- path: string
  
  path to the file to read
- data: Buffer
  
  data to write to the file
- Optional options: WriteOptions
  
  write options
Returns Promise<void>
Overrides FileSystem.writeFile
- Defined in packages/core/src/fs/cachedFileSystem.ts:42

Class CachedFileSystemAdapter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

innerFs: FileSystem

Returns CachedFileSystemAdapter

Properties

Private Readonly innerFs

Methods

appendFile

Parameters

path: string

body: string | Buffer

Optional options: OutputOptions

Returns Promise<void>

clearCache

Returns void

createDirectory

Parameters

path: string

Returns Promise<void>

find

Parameters

globPatterns: GlobPatterns

Optional options: FindOptions

Returns AsyncGenerator<string, any, unknown>

Example

findFiles

Parameters

patterns: string | string[]

Returns Promise<string[]>

isDirectory

Parameters

path: string

Returns Promise<boolean>

isFile

Parameters

path: string

Returns Promise<boolean>

outputFile

Parameters

path: string

Optional body: string | Buffer

Optional options: OutputOptions

Returns Promise<void>

pathExists

Parameters

path: string

Returns Promise<boolean>

readDirectory

Parameters

path: string

Returns Promise<FileInfo[]>

readFile

Parameters

fileName: string

Returns Promise<Buffer>

readFileAsString

Parameters

fileName: string

encoding: BufferEncoding = 'utf-8'

Returns Promise<string>

stat

Parameters

path: string

Optional options: StatsOptions

Returns Promise<undefined | FileStat>

writeFile

Parameters

path: string

data: Buffer

Optional options: WriteOptions

Returns Promise<void>

Settings

Member Visibility

`Private` `Readonly` innerFs

`Optional` options: OutputOptions

`Optional` options: FindOptions

`Optional` body: string | Buffer

`Optional` options: OutputOptions

`Optional` options: StatsOptions

`Optional` options: WriteOptions