Class SSHFilesystem

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

Hierarchy

Filesystem
- SSHFilesystem

Index

Constructors

constructor

Properties

baseConfig sshClient?

Constructors

constructor

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

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>
Called when the Filesystem driver is destroyed. Do any cleanup here.

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

getMetadata

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

getPath

getPath(storePath: string): UniversalPath
Get a UniversalPath that refers to a file on this filesystem.
Parameters
- storePath: string
Returns UniversalPath
Inherited from Filesystem.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 Filesystem.getPrefix
- Defined in src/util/support/path/SSHFilesystem.ts:22

getSFTP

getSFTP(): Promise<SFTPWrapper>
Using getSSH(), create a new SFTP helper based on that connection.

Returns Promise<SFTPWrapper>
- Defined in src/util/support/path/SSHFilesystem.ts:232

getSSH

getSSH(): Promise<Client>
Using the provided hostConfig, create and cache the SSH connection to the host. If a connection already exists, re-use it.

Returns Promise<Client>
- Defined in src/util/support/path/SSHFilesystem.ts:212

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 Filesystem.getStoreFileAsStream
- Defined in src/util/support/path/SSHFilesystem.ts:42

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 Filesystem.getStoreFileAsTemp
- Defined in src/util/support/path/SSHFilesystem.ts:26

list

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

`Protected` metadataPath

metadataPath(storePath: string): string
Protected
Resolve the given store path to an absolute path of a metadata file on the remote filesystem.
Parameters
- storePath: string
Returns string
- Defined in src/util/support/path/SSHFilesystem.ts:260

mkdir

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

`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 Filesystem.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 Filesystem.open
- Defined in src/util/support/path/Filesystem.ts:91

putLocalFile

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

putStoreFileAsStream

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

remove

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

setMetadata

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

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 Filesystem.stat
- Defined in src/util/support/path/SSHFilesystem.ts:105

`Protected` storePath

storePath(storePath: string): string
Protected
Resolve the given store path to an absolute path on the remote filesystem.
Parameters
- storePath: string
Returns string
- Defined in src/util/support/path/SSHFilesystem.ts:251

`Protected` streamToString

streamToString(stream: ReadableStream): Promise<string>
Protected
Given a readable stream, cast it to a string.
Parameters
- stream: ReadableStream
Returns Promise<string>
- Defined in src/util/support/path/SSHFilesystem.ts:269

`Protected` tempName

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

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

touch

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

Class SSHFilesystem

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

baseConfig: { baseDir: string; ssh: ConnectConfig; }

baseDir: string

ssh: ConnectConfig

Returns SSHFilesystem

Properties

Protected Readonly baseConfig

Type declaration

baseDir: string

ssh: ConnectConfig

Private Optional sshClient

Methods

close

Returns Promise<void>

getMetadata

Parameters

storePath: string

Returns Promise<FileMetadata>

getPath

Parameters

storePath: string

Returns UniversalPath

getPrefix

Example

Example

Returns string

getSFTP

Returns Promise<SFTPWrapper>

getSSH

Returns Promise<Client>

getStoreFileAsStream

Parameters

args: { storePath: string; }

storePath: string

Returns Promise<Readable>

getStoreFileAsTemp

Parameters

args: { storePath: string; }

storePath: string

Returns Promise<UniversalPath>

list

Parameters

storePath: string

Returns Promise<Collection<string>>

Protected metadataPath

Parameters

storePath: string

Returns string

mkdir

Parameters

args: { storePath: string; }

storePath: string

Returns Promise<void>

Protected normalizeTags

Example

Parameters

Optional tag: string

Optional tags: string[]

Returns string[]

open

Returns Awaitable<void>

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 Promise<void>

putStoreFileAsStream

baseConfig: {
baseDir: string;
ssh: ConnectConfig;
}

`Protected` `Readonly` baseConfig

`Private` `Optional` sshClient

args: {
storePath: string;
}

args: {
storePath: string;
}

`Protected` metadataPath

args: {
storePath: string;
}

`Protected` normalizeTags

`Optional` tag: string

`Optional` tags: string[]

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

`Optional` mimeType?: string

`Optional` tag?: string

`Optional` tags?: string[]

args: {
storePath: string;
}

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

`Optional` recursive?: boolean

args: {
storePath: string;
}

`Protected` storePath

`Protected` streamToString

`Protected` tempName

args: {
storePath: string;
}