Class ShareFolderClient

A client for accessing a share folder instance.

Hierarchy

ShareFolderClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ShareFolderClient(opts?: ShareFolderClientOptions): ShareFolderClient

- Defined in client.ts:82
Initializes a new instance of that class.

Parameters
- Optional opts: ShareFolderClientOptions
  
  Custom options.
Returns ShareFolderClient

Properties

account

account: Account

The account to use.

host

host: string

Gets the address of the host.

port

port: number

Gets the TCP port of the host.

ssl

ssl: boolean

Gets if SSL should be used or not.

Methods

Private delete

delete(path: string, data?: Buffer, headers?: any): Promise<ShareFolderClientResult>

- Defined in client.ts:120
Parameters
- path: string
- Optional data: Buffer
- Optional headers: any
Returns Promise<ShareFolderClientResult>

download

download(path: string, stream?: WritableStream): Promise<Buffer | undefined>

- Defined in client.ts:133
Downloads a file.

Parameters
- path: string
  
  The path to the remote file.
- Optional stream: WritableStream
Returns Promise<Buffer | undefined>

The promise with the downloaded data (if 'stream' is not defined).

Private get

get(path: string, headers?: any): Promise<ShareFolderClientResult>

- Defined in client.ts:158
Parameters
- path: string
- Optional headers: any
Returns Promise<ShareFolderClientResult>

list

list(path?: string): Promise<DirectoryEntry[]>

- Defined in client.ts:175
Lists a directory.

Parameters
- Default value path: string = "/"
Returns Promise<DirectoryEntry[]>

The list of entries.

Private post

post(path: string, data?: any, headers?: any): Promise<ShareFolderClientResult>

- Defined in client.ts:210
Parameters
- path: string
- Optional data: any
- Optional headers: any
Returns Promise<ShareFolderClientResult>

Private put

put(path: string, data?: Buffer, headers?: any): Promise<ShareFolderClientResult>

- Defined in client.ts:215
Parameters
- path: string
- Optional data: Buffer
- Optional headers: any
Returns Promise<ShareFolderClientResult>

remove

remove(path: string): Promise<DirectoryEntry>

- Defined in client.ts:227
Removes a file or folder.

Parameters
- path: string
  
  The path to the file or folder.
Returns Promise<DirectoryEntry>

The promise with the entry of the removed item.

Private request

request(path: string, method: string, data?: any, headers?: any): Promise<ShareFolderClientResult>

- Defined in client.ts:241
Parameters
- path: string
- method: string
- Optional data: any
- Optional headers: any
Returns Promise<ShareFolderClientResult>

upload

upload(path: string, data: any): Promise<DirectoryEntry>

- Defined in client.ts:363
Uploads a file.

Parameters
- path: string
  
  The path to the remote file.
- data: any
  
  The data (can be a stream) to upload.
Returns Promise<DirectoryEntry>

The directory entry of the file.

Generated using TypeDoc