Interface SophyInterface

Hierarchy

SophyInterface

Implemented by

Sophy

Index

Properties

adapter

Methods

Properties

Readonly adapter

adapter: AdapterInterface

Adapter instance.

Methods

append

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

- Defined in interfaces/Sophy/SophyInterface.ts:124
Append a contents to a file.

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

copy

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

- Defined in interfaces/Sophy/SophyInterface.ts:148
Copy a file.

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

delete

delete(path: string): PromiseOr

- Defined in interfaces/Sophy/SophyInterface.ts:155
Delete a file or directory.

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

directory

directory(path: string): Directory

- Defined in interfaces/Sophy/SophyInterface.ts:29
Get Directory node object.

Parameters
- path: string
  
  Path to directory.
Returns Directory

file

file(path: string): File

- Defined in interfaces/Sophy/SophyInterface.ts:22
Get File node object.

Parameters
- path: string
  
  Path to file.
Returns File

getMime

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

- Defined in interfaces/Sophy/SophyInterface.ts:71
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/Sophy/SophyInterface.ts:64
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/Sophy/SophyInterface.ts:36
Check whether a file or directory exists.

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

listChildren

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

- Defined in interfaces/Sophy/SophyInterface.ts:57
List children of the directory.

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

makeDirectory

makeDirectory(path: string): PromiseOr<Directory>

- Defined in interfaces/Sophy/SophyInterface.ts:162
Make directory.

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

move

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

- Defined in interfaces/Sophy/SophyInterface.ts:140
Move a file or directory.

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

prepend

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

- Defined in interfaces/Sophy/SophyInterface.ts:132
Prepend a contents to a file.

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

put

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

- Defined in interfaces/Sophy/SophyInterface.ts:109
Create or Update a file.

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

putStream

putStream(path: string): PromiseOr<Stream>

- Defined in interfaces/Sophy/SophyInterface.ts:116
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/Sophy/SophyInterface.ts:43
Ready a file.

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

readStream

readStream(path: string): Stream

- Defined in interfaces/Sophy/SophyInterface.ts:50
Read a file using a stream.

Parameters
- path: string
  
  Path to file.
Returns Stream

update

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

- Defined in interfaces/Sophy/SophyInterface.ts:94
Update a file.

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

updateStream

updateStream(path: string): Stream

- Defined in interfaces/Sophy/SophyInterface.ts:101
Update a file using a stream.

Parameters
- path: string
  
  Path to file.
Returns Stream

write

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

- Defined in interfaces/Sophy/SophyInterface.ts:79
Write a new file.

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

writeStream

writeStream(path: string): Stream

- Defined in interfaces/Sophy/SophyInterface.ts:86
Write a new file using a stream.

Parameters
- path: string
  
  Path to file.
Returns Stream

Generated using TypeDoc