Class LocalFileSystem

Local-disk implementation of the agnostic FileSystem contract.

All operations are async (non-blocking) and CONFINED to the configured root directory: any path that resolves outside the root is rejected, so a caller-supplied path such as ../../etc/passwd can never escape the disk. This mirrors how an object store confines access to a bucket, which is exactly what makes a future S3FileSystem a drop-in for the same interface.

Implements

FileSystem

Index

Constructors

Properties

Methods

copy delete exists files get getText lastModified makeDirectory mimeType move put readStream size stat url writeStream create

Constructors

constructor

new LocalFileSystem(options?: FileSystemOptions): LocalFileSystem
Create a LocalFileSystem.
Parameters
- options: FileSystemOptions = {}
  The disk options.
Returns LocalFileSystem

Properties

`Readonly`name

name: string

A human-readable disk name (e.g. 'local', 's3'), used by the StorageManager.

Methods

copy

copy(source: string, destination: string): Promise<void>
Parameters
- source: string
- destination: string
Returns Promise<void>

Inherit Doc

Implementation of FileSystem.copy

delete

delete(path: string): Promise<boolean>
Parameters
- path: string
Returns Promise<boolean>

Inherit Doc

Implementation of FileSystem.delete

exists

exists(path: string): Promise<boolean>
Parameters
- path: string
Returns Promise<boolean>

Inherit Doc

Implementation of FileSystem.exists

files

files(directory?: string, recursive?: boolean): Promise<string[]>
Parameters
- directory: string = ''
- recursive: boolean = false
Returns Promise<string[]>

Inherit Doc

Implementation of FileSystem.files

get

get(path: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- path: string
Returns Promise<Buffer<ArrayBufferLike>>

Inherit Doc

Implementation of FileSystem.get

getText

getText(path: string, encoding?: BufferEncoding): Promise<string>
Parameters
- path: string
- encoding: BufferEncoding = 'utf-8'
Returns Promise<string>

Inherit Doc

Implementation of FileSystem.getText

lastModified

lastModified(path: string): Promise<number>
Parameters
- path: string
Returns Promise<number>

Inherit Doc

Implementation of FileSystem.lastModified

makeDirectory

makeDirectory(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>

Inherit Doc

Implementation of FileSystem.makeDirectory

mimeType

mimeType(path: string): Promise<string>
Parameters
- path: string
Returns Promise<string>

Inherit Doc

Implementation of FileSystem.mimeType

move

move(source: string, destination: string): Promise<void>
Parameters
- source: string
- destination: string
Returns Promise<void>

Inherit Doc

Implementation of FileSystem.move

put

put(path: string, content: string | Buffer<ArrayBufferLike>): Promise<void>
Parameters
- path: string
- content: string | Buffer<ArrayBufferLike>
Returns Promise<void>

Inherit Doc

Implementation of FileSystem.put

readStream

readStream(path: string): Promise<Readable>
Parameters
- path: string
Returns Promise<Readable>

Inherit Doc

Implementation of FileSystem.readStream

size

size(path: string): Promise<number>
Parameters
- path: string
Returns Promise<number>

Inherit Doc

Implementation of FileSystem.size

stat

stat(path: string): Promise<StorageStat>
Parameters
- path: string
Returns Promise<StorageStat>

Inherit Doc

Implementation of FileSystem.stat

url

url(path: string): Promise<string>
Parameters
- path: string
Returns Promise<string>

Inherit Doc

Implementation of FileSystem.url

writeStream

writeStream(path: string, stream: Readable): Promise<void>
Parameters
- path: string
- stream: Readable
Returns Promise<void>

Inherit Doc

Implementation of FileSystem.writeStream

`Static`create

create(options?: FileSystemOptions): LocalFileSystem
Create a LocalFileSystem.
Parameters
- options: FileSystemOptions = {}
  The disk options (root defaults to the current working directory).
Returns LocalFileSystem
A new LocalFileSystem.