Interface AdapterInterface

Hierarchy

AdapterInterface

Implemented by

Index

Properties

root

Methods

Properties

Readonly root

root: string

Root path.

Methods

append

append(path: string, contents: string): PromiseOr<FileMeta>

- Defined in interfaces/Adapter/AdapterInterface.ts:109
Append a contents to a file.

Parameters
- path: string
  
  Path to file.
- contents: string
  
  Append contents.
Returns PromiseOr<FileMeta>

copy

copy(path: string, newPath: string): PromiseOr<NodeMeta>

- Defined in interfaces/Adapter/AdapterInterface.ts:133
Copy a file.

Parameters
- path: string
  
  Path to file.
- newPath: string
  
  Copy destination path.
Returns PromiseOr<NodeMeta>

delete

delete(path: string): PromiseOr

- Defined in interfaces/Adapter/AdapterInterface.ts:140
Delete a file or directory.

Parameters
- path: string
  
  Path to file or directory.
Returns PromiseOr

getMime

getMime(path: string): PromiseOr<string | false>

- Defined in interfaces/Adapter/AdapterInterface.ts:56
Get MIME type of the file.

Parameters
- path: string
  
  Path to file.
Returns PromiseOr<string | false>

getSize

getSize(path: string): PromiseOr<number>

- Defined in interfaces/Adapter/AdapterInterface.ts:49
Get size of the file or directory.

Parameters
- path: string
  
  Path to file or directory.
Returns PromiseOr<number>

has

has(path: string): PromiseOr<boolean>

- Defined in interfaces/Adapter/AdapterInterface.ts:21
Check whether a file or directory exists.

Parameters
- path: string
  
  Path to file or directory.
Returns PromiseOr<boolean>

listChildren

listChildren(path: string): PromiseOr<NodeMeta[]>

- Defined in interfaces/Adapter/AdapterInterface.ts:42
List children of the directory.

Parameters
- path: string
  
  Path to directory.
Returns PromiseOr<NodeMeta[]>

makeDirectory

makeDirectory(path: string): PromiseOr<DirectoryMeta>

- Defined in interfaces/Adapter/AdapterInterface.ts:147
Make directory.

Parameters
- path: string
  
  Path to directory.
Returns PromiseOr<DirectoryMeta>

move

move(path: string, newPath: string): PromiseOr<NodeMeta>

- Defined in interfaces/Adapter/AdapterInterface.ts:125
Move a file or directory.

Parameters
- path: string
  
  Path to the file or directory.
- newPath: string
  
  Move destination path.
Returns PromiseOr<NodeMeta>

prepend

prepend(path: string, contents: string): PromiseOr<FileMeta>

- Defined in interfaces/Adapter/AdapterInterface.ts:117
Prepend a contents to a file.

Parameters
- path: string
  
  Path to file.
- contents: string
  
  Prepend contents.
Returns PromiseOr<FileMeta>

put

put(path: string, contents: string): PromiseOr<FileMeta>

- Defined in interfaces/Adapter/AdapterInterface.ts:94
Create or Update a file.

Parameters
- path: string
  
  Path to file.
- contents: string
  
  Put contents.
Returns PromiseOr<FileMeta>

putStream

putStream(path: string): PromiseOr<Stream>

- Defined in interfaces/Adapter/AdapterInterface.ts:101
Create or Update a file using a stream.

Parameters
- path: string
  
  Path to file.
Returns PromiseOr<Stream>

read

read(path: string): PromiseOr<string>

- Defined in interfaces/Adapter/AdapterInterface.ts:28
Ready a file.

Parameters
- path: string
  
  Path to file.
Returns PromiseOr<string>

readStream

readStream(path: string): Stream

- Defined in interfaces/Adapter/AdapterInterface.ts:35
Read a file using a stream.

Parameters
- path: string
  
  Path to file.
Returns Stream

update

update(path: string, contents: string): PromiseOr<FileMeta>

- Defined in interfaces/Adapter/AdapterInterface.ts:79
Update a file.

Parameters
- path: string
  
  Path to file.
- contents: string
  
  Contents.
Returns PromiseOr<FileMeta>

updateStream

updateStream(path: string): Stream

- Defined in interfaces/Adapter/AdapterInterface.ts:86
Update a file using a stream.

Parameters
- path: string
  
  Path to file.
Returns Stream

write

write(path: string, contents: string): PromiseOr<FileMeta>

- Defined in interfaces/Adapter/AdapterInterface.ts:64
Write a new file.

Parameters
- path: string
  
  Path to file.
- contents: string
  
  Write contents.
Returns PromiseOr<FileMeta>

writeStream

writeStream(path: string): Stream

- Defined in interfaces/Adapter/AdapterInterface.ts:71
Write a new file using a stream.

Parameters
- path: string
  
  Path to file.
Returns Stream

Generated using TypeDoc