Class SSHFilesystem

A Filesystem implementation that stores files on remote hosts via SFTP/SSH.

Hierarchy

Filesystem
- SSHFilesystem

Index

Constructors

constructor

Properties

Constructors

constructor

new SSHFilesystem(baseConfig: { baseDir: string; ssh: ConnectConfig }): SSHFilesystem

Overrides Filesystem.constructor
- Defined in src/util/support/path/SSHFilesystem.ts:13
Parameters
- baseConfig: { baseDir: string; ssh: ConnectConfig }
  - baseDir: string
  - ssh: ConnectConfig
Returns SSHFilesystem

Properties

Protected Readonly baseConfig

baseConfig: { baseDir: string; ssh: ConnectConfig }

Type declaration

baseDir: string
ssh: ConnectConfig

Private Optional sshClient

sshClient: Client

Methods

close

close(): Promise<void>

Overrides Filesystem.close
- Defined in src/util/support/path/SSHFilesystem.ts:203
Returns Promise<void>

getMetadata

getMetadata(storePath: string): Promise<FileMetadata>

Overrides Filesystem.getMetadata
- Defined in src/util/support/path/SSHFilesystem.ts:171
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/SSHFilesystem.ts:21
Returns string

getSFTP

getSFTP(): Promise<SFTPWrapper>

- Defined in src/util/support/path/SSHFilesystem.ts:231
Using getSSH(), create a new SFTP helper based on that connection.

Returns Promise<SFTPWrapper>

getSSH

getSSH(): Promise<Client>

- Defined in src/util/support/path/SSHFilesystem.ts:211
Using the provided hostConfig, create and cache the SSH connection to the host. If a connection already exists, re-use it.

Returns Promise<Client>

getStoreFileAsStream

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

Overrides Filesystem.getStoreFileAsStream
- Defined in src/util/support/path/SSHFilesystem.ts:41
Parameters
- args: { storePath: string }
  - storePath: string
Returns Promise<Readable>

getStoreFileAsTemp

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

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

list

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

Overrides Filesystem.list
- Defined in src/util/support/path/SSHFilesystem.ts:277
Parameters
- storePath: string
Returns Promise<Collection<string>>

Protected metadataPath

metadataPath(storePath: string): string

- Defined in src/util/support/path/SSHFilesystem.ts:259
Resolve the given store path to an absolute path of a metadata file on the remote filesystem.

Parameters
- storePath: string
Returns string

mkdir

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

Overrides Filesystem.mkdir
- Defined in src/util/support/path/SSHFilesystem.ts:71
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(): Awaitable<void>

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

Returns Awaitable<void>

putLocalFile

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

Overrides Filesystem.putLocalFile
- Defined in src/util/support/path/SSHFilesystem.ts:46
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 Promise<void>

putStoreFileAsStream

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

Overrides Filesystem.putStoreFileAsStream
- Defined in src/util/support/path/SSHFilesystem.ts:66
Parameters
- args: { storePath: string }
  - storePath: string
Returns Promise<Writable>

remove

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

Overrides Filesystem.remove
- Defined in src/util/support/path/SSHFilesystem.ts:84
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/SSHFilesystem.ts:189
Parameters
- storePath: string
- meta: FileMetadata
Returns Promise<void>

stat

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

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

Protected storePath

storePath(storePath: string): string

- Defined in src/util/support/path/SSHFilesystem.ts:250
Resolve the given store path to an absolute path on the remote filesystem.

Parameters
- storePath: string
Returns string

Protected streamToString

streamToString(stream: ReadableStream): Promise<string>

- Defined in src/util/support/path/SSHFilesystem.ts:268
Given a readable stream, cast it to a string.

Parameters
- stream: ReadableStream
Returns Promise<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/SSHFilesystem.ts:145
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.