Class Filesystem

Abstract base-class for remote filesystem implementations.

Hierarchy

Filesystem
- LocalFilesystem
- SSHFilesystem

Index

Constructors

constructor

Methods

Constructors

constructor

new Filesystem(): Filesystem

Returns Filesystem

Methods

close

close(): Awaitable<void>

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

Returns Awaitable<void>

Abstract getMetadata

getMetadata(storePath: string): Awaitable<FileMetadata>

- Defined in src/util/support/path/Filesystem.ts:176
Get the metadata object for the given file, if it exists.

Parameters
- storePath: string
Returns Awaitable<FileMetadata>

getPath

getPath(storePath: string): UniversalPath

- 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

Abstract getPrefix

getPrefix(): string

- Defined in src/util/support/path/Filesystem.ts:103
Get the URI prefix for this filesystem.

example

file://

example

s3://

Returns string

Abstract getStoreFileAsStream

getStoreFileAsStream(args: { storePath: string }): Awaitable<Readable>

- Defined in src/util/support/path/Filesystem.ts:140
Open a readable stream for a file in the remote filesystem.

Parameters
- args: { storePath: string }
  - storePath: string
Returns Awaitable<Readable>

Abstract getStoreFileAsTemp

getStoreFileAsTemp(args: { storePath: string }): Awaitable<UniversalPath>

- Defined in src/util/support/path/Filesystem.ts:134
Download a file in the remote filesystem to the local filesystem and return it as a UniversalPath.

Parameters
- args: { storePath: string }
  - storePath: string
Returns Awaitable<UniversalPath>

Abstract list

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

- Defined in src/util/support/path/Filesystem.ts:188
List direct children of this resource.

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

Abstract mkdir

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

- Defined in src/util/support/path/Filesystem.ts:170
Create the given path on the store as a directory, recursively.

Parameters
- args: { storePath: string }
  - storePath: string
Returns Awaitable<void>

Protected normalizeTags

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

- 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(): Awaitable<void>

- Defined in src/util/support/path/Filesystem.ts:91
Called when the Filesystem driver is initialized. Do any standup here.

Returns Awaitable<void>

Abstract putLocalFile

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

- Defined in src/util/support/path/Filesystem.ts:128
Store a file from the local filesystem into the remote filesystem.
example
```
await store.putLocalFile({
    localPath: '/tmp/temp.file',
    storePath: 'my/upload-key/temp.file',
    mimeType: 'application/json',
    tags: ['json', 'user-data'],
})
```
Parameters
- args: { localPath: string; mimeType?: string; storePath: string; tag?: string; tags?: string[] }
  - localPath: string
  - Optional mimeType?: string
  - storePath: string
  - Optional tag?: string
  - Optional tags?: string[]
Returns Awaitable<void>

Abstract putStoreFileAsStream

putStoreFileAsStream(args: { storePath: string }): Awaitable<Writable>

- Defined in src/util/support/path/Filesystem.ts:146
Open a writable stream for a file in the remote filesystem.

Parameters
- args: { storePath: string }
  - storePath: string
Returns Awaitable<Writable>

Abstract remove

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

- Defined in src/util/support/path/Filesystem.ts:164
Remove the given resource(s) from the remote filesystem.

Parameters
- args: { recursive?: boolean; storePath: string }
  - Optional recursive?: boolean
  - storePath: string
Returns Awaitable<void>

Abstract setMetadata

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

- Defined in src/util/support/path/Filesystem.ts:183
Set the metadata object for the given file, if the file exists.

Parameters
- storePath: string
- meta: FileMetadata
Returns Awaitable<void>

Abstract stat

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

- Defined in src/util/support/path/Filesystem.ts:152
Fetch some information about a file that may or may not be in the remote filesystem without fetching the entire file.

Parameters
- args: { storePath: string }
  - storePath: string
Returns Awaitable<Stat>

Protected tempName

tempName(): string

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

Returns string

Abstract touch

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

- Defined in src/util/support/path/Filesystem.ts:158
If the file does not exist in the remote filesystem, create it. If it does exist, update the modify timestamps.

Parameters
- args: { storePath: string }
  - storePath: string
Returns Awaitable<void>

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

Extollo is a free & libre application framework in TypeScript.