Class LocalFilesystem

A Filesystem implementation that stores files on the local disk.

todo: walk

Hierarchy

Filesystem
- LocalFilesystem

Index

Constructors

constructor

Properties

baseConfig

Methods

Constructors

constructor

new LocalFilesystem(baseConfig: LocalFilesystemConfig): LocalFilesystem

Overrides Filesystem.constructor
- Defined in src/util/support/path/LocalFilesystem.ts:17
Parameters
- baseConfig: LocalFilesystemConfig
Returns LocalFilesystem

Properties

Protected Readonly baseConfig

baseConfig: LocalFilesystemConfig

Methods

close

close(): Awaitable<void>

Inherited from Filesystem.close
- Defined in src/util/support/path/Filesystem.ts:96
Called when the Filesystem driver is destroyed. Do any cleanup here.

Returns Awaitable<void>

getMetadata

getMetadata(storePath: string): Promise<FileMetadata>

Overrides Filesystem.getMetadata
- Defined in src/util/support/path/LocalFilesystem.ts:57
Parameters
- storePath: string
Returns Promise<FileMetadata>

getPath

getPath(storePath: string): UniversalPath

Inherited from Filesystem.getPath
- Defined in src/util/support/path/Filesystem.ts:109
Get a UniversalPath that refers to a file on this filesystem.

Parameters
- storePath: string
Returns UniversalPath

getPrefix

getPrefix(): string

Overrides Filesystem.getPrefix
- Defined in src/util/support/path/LocalFilesystem.ts:31
Returns string

getStoreFileAsStream

getStoreFileAsStream(args: { storePath: string }): ReadStream | Promise<ReadStream>

Overrides Filesystem.getStoreFileAsStream
- Defined in src/util/support/path/LocalFilesystem.ts:49
Parameters
- args: { storePath: string }
  - storePath: string
Returns ReadStream | Promise<ReadStream>

getStoreFileAsTemp

getStoreFileAsTemp(__namedParameters: { storePath: string }): Promise<UniversalPath>

Overrides Filesystem.getStoreFileAsTemp
- Defined in src/util/support/path/LocalFilesystem.ts:43
Parameters
- __namedParameters: { storePath: string }
  - storePath: string
Returns Promise<UniversalPath>

list

list(storePath: string): Promise<Collection<string>>

Overrides Filesystem.list
- Defined in src/util/support/path/LocalFilesystem.ts:179
List all immediate children of the given path.

Parameters
- storePath: string
Returns Promise<Collection<string>>

Protected metadataPath

metadataPath(storePath: string): string

- Defined in src/util/support/path/LocalFilesystem.ts:171
Given a relative path in the store, resolve it to an absolute path to the metadata JSON file for that path.

Parameters
- storePath: string
Returns string

mkdir

mkdir(args: { storePath: string }): Promise<void>

Overrides Filesystem.mkdir
- Defined in src/util/support/path/LocalFilesystem.ts:152
Parameters
- args: { storePath: string }
  - storePath: string
Returns Promise<void>

Protected normalizeTags

normalizeTags(tag?: string, tags?: string[]): string[]

Inherited from Filesystem.normalizeTags
- Defined in src/util/support/path/Filesystem.ts:203
Normalize the input tags into a single array of strings. This is useful for implementing the fluent interface for putLocalFile().
example
```
const tags: string[] = this._normalizeTags(args.tag, args.tags)
```
Parameters
- Optional tag: string
- Optional tags: string[]
Returns string[]

open

open(): Promise<void>

Overrides Filesystem.open
- Defined in src/util/support/path/LocalFilesystem.ts:24
Returns Promise<void>

putLocalFile

putLocalFile(__namedParameters: { localPath: string; mimeType?: string; storePath: string; tag?: string; tags?: string[] }): Promise<void>

Overrides Filesystem.putLocalFile
- Defined in src/util/support/path/LocalFilesystem.ts:35
Parameters
- __namedParameters: { localPath: string; mimeType?: string; storePath: string; tag?: string; tags?: string[] }
  - localPath: string
  - Optional mimeType?: string
  - storePath: string
  - Optional tag?: string
  - Optional tags?: string[]
Returns Promise<void>

putStoreFileAsStream

putStoreFileAsStream(args: { storePath: string }): WriteStream | Promise<WriteStream>

Overrides Filesystem.putStoreFileAsStream
- Defined in src/util/support/path/LocalFilesystem.ts:53
Parameters
- args: { storePath: string }
  - storePath: string
Returns WriteStream | Promise<WriteStream>

remove

remove(args: { recursive?: boolean; storePath: string }): Promise<void>

Overrides Filesystem.remove
- Defined in src/util/support/path/LocalFilesystem.ts:134
Parameters
- args: { recursive?: boolean; storePath: string }
  - Optional recursive?: boolean
  - storePath: string
Returns Promise<void>

setMetadata

setMetadata(storePath: string, meta: FileMetadata): Promise<void>

Overrides Filesystem.setMetadata
- Defined in src/util/support/path/LocalFilesystem.ts:68
Parameters
- storePath: string
- meta: FileMetadata
Returns Promise<void>

stat

stat(args: { storePath: string }): Promise<Stat>

Overrides Filesystem.stat
- Defined in src/util/support/path/LocalFilesystem.ts:77
Parameters
- args: { storePath: string }
  - storePath: string
Returns Promise<Stat>

Protected storePath

storePath(storePath: string): string

- Defined in src/util/support/path/LocalFilesystem.ts:161
Given a relative path in the store, resolve it to an absolute path.

Parameters
- storePath: string
Returns string

Protected tempName

tempName(): string

Inherited from Filesystem.tempName
- Defined in src/util/support/path/Filesystem.ts:217
Generate the name of a temp-file on the LOCAL filesystem.

Returns string

touch

touch(args: { storePath: string }): Promise<void>

Overrides Filesystem.touch
- Defined in src/util/support/path/LocalFilesystem.ts:110
Parameters
- args: { storePath: string }
  - storePath: string
Returns Promise<void>

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.