Class Sophy

Hierarchy

Sophy

Implements

SophyInterface

Index

Constructors

constructor

Properties

adapter

Methods

Constructors

constructor

new Sophy(adapter: AdapterInterface): Sophy

- Defined in classes/Sophy/Sophy.ts:15
Sophy constructor.

Parameters
- adapter: AdapterInterface
  
  Adapter instance.
Returns Sophy

Properties

Readonly adapter

adapter: AdapterInterface

Adapter instance.

Methods

append

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

Implementation of SophyInterface.append
- Defined in classes/Sophy/Sophy.ts:169
Append a contents to a file.

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

copy

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

Implementation of SophyInterface.copy
- Defined in classes/Sophy/Sophy.ts:204
Copy a file.

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

delete

delete(path: string): Promise<void>

Implementation of SophyInterface.delete
- Defined in classes/Sophy/Sophy.ts:215
Delete a file or directory.

Parameters
- path: string
  
  Path to file or directory.
Returns Promise<void>

directory

directory(path: string): Directory

Implementation of SophyInterface.directory
- Defined in classes/Sophy/Sophy.ts:40
Get Directory node object.

Parameters
- path: string
  
  Path to directory.
Returns Directory

file

file(path: string): File

Implementation of SophyInterface.file
- Defined in classes/Sophy/Sophy.ts:31
Get File node object.

Parameters
- path: string
  
  Path to file.
Returns File

getMime

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

Implementation of SophyInterface.getMime
- Defined in classes/Sophy/Sophy.ts:96
Get MIME type of the file.

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

getSize

getSize(path: string): number | Promise<number>

Implementation of SophyInterface.getSize
- Defined in classes/Sophy/Sophy.ts:87
Get size of the file or directory.

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

has

has(path: string): false | true | Promise<boolean>

Implementation of SophyInterface.has
- Defined in classes/Sophy/Sophy.ts:49
Check whether a file or directory exists.

Parameters
- path: string
  
  Path to file or directory.
Returns false | true | Promise<boolean>

listChildren

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

Implementation of SophyInterface.listChildren
- Defined in classes/Sophy/Sophy.ts:76
List children of the directory.

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

makeDirectory

makeDirectory(path: string): Promise<Directory>

Implementation of SophyInterface.makeDirectory
- Defined in classes/Sophy/Sophy.ts:224
Make directory.

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

move

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

Implementation of SophyInterface.move
- Defined in classes/Sophy/Sophy.ts:192
Move a file or directory.

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

Private nodeFromMeta

nodeFromMeta(meta: FileMeta): File
nodeFromMeta(meta: DirectoryMeta): Directory
nodeFromMeta(meta: NodeMeta): Node

- Defined in classes/Sophy/Sophy.ts:235
Make File from a FileMeta object.

Parameters
- meta: FileMeta
  
  Node meta object.
Returns File
- Defined in classes/Sophy/Sophy.ts:242
Make Directory from a DirectoryMeta object.

Parameters
- meta: DirectoryMeta
  
  Node meta object.
Returns Directory
- Defined in classes/Sophy/Sophy.ts:249
Make Directory from a DirectoryMeta object.

Parameters
- meta: NodeMeta
  
  Node meta object.
Returns Node

prepend

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

Implementation of SophyInterface.prepend
- Defined in classes/Sophy/Sophy.ts:181
Prepend a contents to a file.

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

put

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

Implementation of SophyInterface.put
- Defined in classes/Sophy/Sophy.ts:148
Create or Update a file.

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

putStream

putStream(path: string): Stream | Promise<Stream>

Implementation of SophyInterface.putStream
- Defined in classes/Sophy/Sophy.ts:159
Create or Update a file using a stream.

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

read

read(path: string): string | Promise<string>

Implementation of SophyInterface.read
- Defined in classes/Sophy/Sophy.ts:58
Ready a file.

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

readStream

readStream(path: string): Stream

Implementation of SophyInterface.readStream
- Defined in classes/Sophy/Sophy.ts:67
Read a file using a stream.

Parameters
- path: string
  
  Path to file.
Returns Stream

update

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

Implementation of SophyInterface.update
- Defined in classes/Sophy/Sophy.ts:127
Update a file.

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

updateStream

updateStream(path: string): Stream

Implementation of SophyInterface.updateStream
- Defined in classes/Sophy/Sophy.ts:138
Update a file using a stream.

Parameters
- path: string
  
  Path to file.
Returns Stream

write

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

Implementation of SophyInterface.write
- Defined in classes/Sophy/Sophy.ts:106
Write a new file.

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

writeStream

writeStream(path: string): Stream

Implementation of SophyInterface.writeStream
- Defined in classes/Sophy/Sophy.ts:117
Write a new file using a stream.

Parameters
- path: string
  
  Path to file.
Returns Stream

Generated using TypeDoc