Class HTTPFilesystem

A filesystem implementation that reads files over HTTPS.

Hierarchy

ReadOnlyFilesystem
- HTTPFilesystem

Index

Constructors

Methods

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

Constructors

constructor

new HTTPFilesystem(): HTTPFilesystem
Returns HTTPFilesystem

Inherited from ReadOnlyFilesystem.constructor

Methods

close

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

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

getMetadata

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

getPath

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

getPrefix

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

Example
file://

Example
s3://

Returns string
Overrides ReadOnlyFilesystem.getPrefix
- Defined in src/util/support/path/HTTPFilesystem.ts:19

getStoreFileAsStream

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

getStoreFileAsTemp

getStoreFileAsTemp(args: {
storePath: string;
}): Promise<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 Promise<UniversalPath>
Overrides ReadOnlyFilesystem.getStoreFileAsTemp
- Defined in src/util/support/path/HTTPFilesystem.ts:23

list

list(): Awaitable<Collection<string>>
List direct children of this resource.

Returns Awaitable<Collection<string>>
Overrides ReadOnlyFilesystem.list
- Defined in src/util/support/path/HTTPFilesystem.ts:83

mkdir

mkdir(): Awaitable<void>
Create the given path on the store as a directory, recursively.

Returns Awaitable<void>
Inherited from ReadOnlyFilesystem.mkdir
- Defined in src/util/support/path/ReadOnlyFilesystem.ts:35

`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[]
Inherited from ReadOnlyFilesystem.normalizeTags
- 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>
Inherited from ReadOnlyFilesystem.open
- Defined in src/util/support/path/Filesystem.ts:91

putLocalFile

putLocalFile(): 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'],
})
```
Returns Awaitable<void>
Inherited from ReadOnlyFilesystem.putLocalFile
- Defined in src/util/support/path/ReadOnlyFilesystem.ts:19

putStoreFileAsStream

putStoreFileAsStream(): Awaitable<Writable>
Open a writable stream for a file in the remote filesystem.

Returns Awaitable<Writable>
Inherited from ReadOnlyFilesystem.putStoreFileAsStream
- Defined in src/util/support/path/ReadOnlyFilesystem.ts:23

remove

remove(): Awaitable<void>
Remove the given resource(s) from the remote filesystem.

Returns Awaitable<void>
Inherited from ReadOnlyFilesystem.remove
- Defined in src/util/support/path/ReadOnlyFilesystem.ts:31

setMetadata

setMetadata(): Awaitable<void>
Set the metadata object for the given file, if the file exists.

Returns Awaitable<void>
Inherited from ReadOnlyFilesystem.setMetadata
- Defined in src/util/support/path/ReadOnlyFilesystem.ts:39

stat

stat(args: {
storePath: string;
}): Promise<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 Promise<Stat>
Overrides ReadOnlyFilesystem.stat
- Defined in src/util/support/path/HTTPFilesystem.ts:52

`Protected` tempName

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

Returns string
Inherited from ReadOnlyFilesystem.tempName
- Defined in src/util/support/path/Filesystem.ts:217

touch

touch(): Awaitable<void>
If the file does not exist in the remote filesystem, create it. If it does exist, update the modify timestamps.

Returns Awaitable<void>
Inherited from ReadOnlyFilesystem.touch
- Defined in src/util/support/path/ReadOnlyFilesystem.ts:27

Class HTTPFilesystem

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns HTTPFilesystem

Methods

close

Returns Awaitable<void>

getMetadata

Parameters

storePath: string

Returns Awaitable<FileMetadata>

getPath

Parameters

storePath: string

Returns UniversalPath

getPrefix

Example

Example

Returns string

getStoreFileAsStream

Parameters

args: { storePath: string; }

storePath: string

Returns Promise<Readable>

getStoreFileAsTemp

Parameters

args: { storePath: string; }

storePath: string

Returns Promise<UniversalPath>

list

Returns Awaitable<Collection<string>>

mkdir

Returns Awaitable<void>

Protected normalizeTags

Example

Parameters

Optional tag: string

Optional tags: string[]

Returns string[]

open

Returns Awaitable<void>

putLocalFile

Example

Returns Awaitable<void>

putStoreFileAsStream

Returns Awaitable<Writable>

remove

Returns Awaitable<void>

setMetadata

Returns Awaitable<void>

stat

Parameters

args: { storePath: string; }

storePath: string

Returns Promise<Stat>

Protected tempName

Returns string

touch

Returns Awaitable<void>

Settings

Member Visibility

Theme

args: {
storePath: string;
}

args: {
storePath: string;
}

`Protected` normalizeTags

`Optional` tag: string

`Optional` tags: string[]

args: {
storePath: string;
}

`Protected` tempName