Class Filesystem`Abstract`

Abstract base-class for remote filesystem implementations.

Hierarchy

Filesystem

Index

Constructors

Methods

close getMetadata getPath getPrefix getStoreFileAsStream getStoreFileAsTemp list mkdir normalizeTags open putLocalFile putStoreFileAsStream remove setMetadata stat tempName touch

Constructors

constructor

new Filesystem(): Filesystem
Returns Filesystem

Methods

close

close(): Awaitable<void>
Called when the Filesystem driver is destroyed. Do any cleanup here.

Returns Awaitable<void>
- Defined in src/util/support/path/Filesystem.ts:96

`Abstract` getMetadata

getMetadata(storePath: string): Awaitable<FileMetadata>
Get the metadata object for the given file, if it exists.
Parameters
- storePath: string
Returns Awaitable<FileMetadata>
- Defined in src/util/support/path/Filesystem.ts:176

getPath

getPath(storePath: string): UniversalPath
Get a UniversalPath that refers to a file on this filesystem.
Parameters
- storePath: string
Returns UniversalPath
- Defined in src/util/support/path/Filesystem.ts:109

`Abstract` getPrefix

getPrefix(): string
Get the URI prefix for this filesystem.

Example
file://

Example
s3://

Returns string
- Defined in src/util/support/path/Filesystem.ts:103

`Abstract` getStoreFileAsStream

getStoreFileAsStream(args: {
storePath: string;
}): Awaitable<Readable>
Open a readable stream for a file in the remote filesystem.
Parameters
- args: {
  storePath: string;
  }
  - storePath: string
Returns Awaitable<Readable>
- Defined in src/util/support/path/Filesystem.ts:140

`Abstract` getStoreFileAsTemp

getStoreFileAsTemp(args: {
storePath: string;
}): Awaitable<UniversalPath>
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>
- Defined in src/util/support/path/Filesystem.ts:134

`Abstract` list

list(storePath: string): Awaitable<Collection<string>>
List direct children of this resource.
Parameters
- storePath: string
Returns Awaitable<Collection<string>>
- Defined in src/util/support/path/Filesystem.ts:188

`Abstract` mkdir

mkdir(args: {
storePath: string;
}): Awaitable<void>
Create the given path on the store as a directory, recursively.
Parameters
- args: {
  storePath: string;
  }
  - storePath: string
Returns Awaitable<void>
- Defined in src/util/support/path/Filesystem.ts:170

`Protected` normalizeTags

normalizeTags(tag?: string, tags?: string[]): string[]
Protected
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[]
- Defined in src/util/support/path/Filesystem.ts:203

open

open(): Awaitable<void>
Called when the Filesystem driver is initialized. Do any standup here.

Returns Awaitable<void>
- Defined in src/util/support/path/Filesystem.ts:91

`Abstract` putLocalFile

putLocalFile(args: {
    localPath: string;
    mimeType?: string;
    storePath: string;
    tag?: string;
    tags?: string[];
}): Awaitable<void>
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>
- Defined in src/util/support/path/Filesystem.ts:128

`Abstract` putStoreFileAsStream

putStoreFileAsStream(args: {
storePath: string;
}): Awaitable<Writable>
Open a writable stream for a file in the remote filesystem.
Parameters
- args: {
  storePath: string;
  }
  - storePath: string
Returns Awaitable<Writable>
- Defined in src/util/support/path/Filesystem.ts:146

`Abstract` remove

remove(args: {
recursive?: boolean;
storePath: string;
}): Awaitable<void>
Remove the given resource(s) from the remote filesystem.
Parameters
- args: {
  recursive?: boolean;
  storePath: string;
  }
  - Optional recursive?: boolean
  - storePath: string
Returns Awaitable<void>
- Defined in src/util/support/path/Filesystem.ts:164

`Abstract` setMetadata

setMetadata(storePath: string, meta: FileMetadata): Awaitable<void>
Set the metadata object for the given file, if the file exists.
Parameters
- storePath: string
- meta: FileMetadata
Returns Awaitable<void>
- Defined in src/util/support/path/Filesystem.ts:183

`Abstract` stat

stat(args: {
storePath: string;
}): Awaitable<Stat>
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>
- Defined in src/util/support/path/Filesystem.ts:152

`Protected` tempName

tempName(): string
Protected
Generate the name of a temp-file on the LOCAL filesystem.

Returns string
- Defined in src/util/support/path/Filesystem.ts:217

`Abstract` touch

touch(args: {
storePath: string;
}): Awaitable<void>
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>
- Defined in src/util/support/path/Filesystem.ts:158

Class FilesystemAbstract

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns Filesystem

Methods

close

Returns Awaitable<void>

Abstract getMetadata

Parameters

storePath: string

Returns Awaitable<FileMetadata>

getPath

Parameters

storePath: string

Returns UniversalPath

Abstract getPrefix

Example

Example

Returns string

Abstract getStoreFileAsStream

Parameters

args: { storePath: string; }

storePath: string

Returns Awaitable<Readable>

Abstract getStoreFileAsTemp

Parameters

args: { storePath: string; }

storePath: string

Returns Awaitable<UniversalPath>

Abstract list

Parameters

storePath: string

Returns Awaitable<Collection<string>>

Abstract mkdir

Parameters

args: { storePath: string; }

storePath: string

Returns Awaitable<void>

Protected normalizeTags

Example

Parameters

Optional tag: string

Optional tags: string[]

Returns string[]

open

Returns Awaitable<void>

Abstract putLocalFile

Example

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

Parameters

args: { storePath: string; }

storePath: string

Returns Awaitable<Writable>

Abstract remove

Parameters

args: { recursive?: boolean; storePath: string; }

Optional recursive?: boolean

storePath: string

Returns Awaitable<void>

Abstract setMetadata

Parameters

storePath: string

meta: FileMetadata

Returns Awaitable<void>

Abstract stat

Parameters

args: { storePath: string; }

storePath: string

Class Filesystem`Abstract`

`Abstract` getMetadata

`Abstract` getPrefix

`Abstract` getStoreFileAsStream

args: {
storePath: string;
}

`Abstract` getStoreFileAsTemp

args: {
storePath: string;
}

`Abstract` list

`Abstract` mkdir

args: {
storePath: string;
}

`Protected` normalizeTags

`Optional` tag: string

`Optional` tags: string[]

`Abstract` putLocalFile

args: {
localPath: string;
mimeType?: string;
storePath: string;
tag?: string;
tags?: string[];
}

`Optional` mimeType?: string

`Optional` tag?: string

`Optional` tags?: string[]

`Abstract` putStoreFileAsStream

args: {
storePath: string;
}

`Abstract` remove

args: {
recursive?: boolean;
storePath: string;
}

`Optional` recursive?: boolean

`Abstract` setMetadata

`Abstract` stat

args: {
storePath: string;
}

`Protected` tempName

`Abstract` touch

args: {
storePath: string;
}