Class Adapter

Hierarchy

Adapter
- LocalAdapter

Implements

AdapterInterface

Index

Constructors

constructor

Properties

root

Methods

Constructors

constructor

new Adapter(root: string): Adapter

- Defined in abstracts/Adapter/Adapter.ts:15
Adapter constructor.

Parameters
- root: string
  
  Root path.
Returns Adapter

Properties

Readonly root

root: string

Root path.

Methods

Abstract append

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

Implementation of AdapterInterface.append
- Defined in abstracts/Adapter/Adapter.ts:140
Append a contents to a file.

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

Abstract copy

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

Implementation of AdapterInterface.copy
- Defined in abstracts/Adapter/Adapter.ts:164
Copy a file or directory.

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

Abstract delete

delete(path: string): PromiseOr

Implementation of AdapterInterface.delete
- Defined in abstracts/Adapter/Adapter.ts:171
Delete a file or directory.

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

Abstract getMime

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

Implementation of AdapterInterface.getMime
- Defined in abstracts/Adapter/Adapter.ts:84
Get MIME type of the file.

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

Abstract getSize

getSize(path: string): PromiseOr<number>

Implementation of AdapterInterface.getSize
- Defined in abstracts/Adapter/Adapter.ts:77
Get size of the file or directory.

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

Abstract has

has(path: string): PromiseOr<boolean>

Implementation of AdapterInterface.has
- Defined in abstracts/Adapter/Adapter.ts:49
Check whether a file or directory exists.

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

Protected joinPaths

joinPaths(...paths: string[]): string

- Defined in abstracts/Adapter/Adapter.ts:40
Join paths.

Parameters
- Rest ...paths: string[]
  
  Paths.
Returns string

Abstract listChildren

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

Implementation of AdapterInterface.listChildren
- Defined in abstracts/Adapter/Adapter.ts:70
List children of the directory.

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

Abstract makeDirectory

makeDirectory(path: string): PromiseOr<DirectoryMeta>

Implementation of AdapterInterface.makeDirectory
- Defined in abstracts/Adapter/Adapter.ts:178
Make directory.

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

Abstract move

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

Implementation of AdapterInterface.move
- Defined in abstracts/Adapter/Adapter.ts:156
Move a file or directory.

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

Abstract prepend

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

Implementation of AdapterInterface.prepend
- Defined in abstracts/Adapter/Adapter.ts:148
Prepend a contents to a file.

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

Abstract put

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

Implementation of AdapterInterface.put
- Defined in abstracts/Adapter/Adapter.ts:125
Create or Update a file.

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

Abstract putStream

putStream(path: string): PromiseOr<Stream>

Implementation of AdapterInterface.putStream
- Defined in abstracts/Adapter/Adapter.ts:132
Create or Update a file using a stream.

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

Abstract read

read(path: string): PromiseOr<string>

Implementation of AdapterInterface.read
- Defined in abstracts/Adapter/Adapter.ts:56
Read a file.

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

Abstract readStream

readStream(path: string): Stream

Implementation of AdapterInterface.readStream
- Defined in abstracts/Adapter/Adapter.ts:63
Read a file using a stream.

Parameters
- path: string
  
  Path to file.
Returns Stream

Protected resolve

resolve(...paths: string[]): string

- Defined in abstracts/Adapter/Adapter.ts:31
Resolve root path and paths.

Parameters
- Rest ...paths: string[]
  
  Paths.
Returns string

Abstract update

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

Implementation of AdapterInterface.update
- Defined in abstracts/Adapter/Adapter.ts:110
Update a file.

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

Abstract updateStream

updateStream(path: string): Stream

Implementation of AdapterInterface.updateStream
- Defined in abstracts/Adapter/Adapter.ts:117
Update a file using a stream.

Parameters
- path: string
  
  Path to file.
Returns Stream

Abstract write

write(path: string, contents: string): PromiseOr<NodeMeta & { type: File }>

Implementation of AdapterInterface.write
- Defined in abstracts/Adapter/Adapter.ts:92
Write a new file.

Parameters
- path: string
  
  Path to file.
- contents: string
  
  Write contents.
Returns PromiseOr<NodeMeta & { type: File }>

Abstract writeStream

writeStream(path: string): Stream

Implementation of AdapterInterface.writeStream
- Defined in abstracts/Adapter/Adapter.ts:102
Write a new file using a stream.

Parameters
- path: string
  
  Path to file.
Returns Stream

Generated using TypeDoc