Class Retrieval

Abstracts retrieval from either URL or Storage.

Hierarchy

Retrieval

Index

Constructors

constructor

Properties

location

Accessors

Methods

Constructors

constructor

new Retrieval(location: string): Retrieval

- Defined in src/retrieval.ts:14
Parameters
- location: string
  
  file path or url (backslashes are replaced with slashes)
Returns Retrieval

Properties

Readonly location

location: Location

Accessors

exists

get exists(): Promise<boolean>

- Defined in src/retrieval.ts:35
Returns Promise<boolean>

storage

get storage(): undefined | Storage

- Defined in src/retrieval.ts:77
Returns undefined | Storage

Methods

append

append(contents: string): void

- Defined in src/retrieval.ts:57
Parameters
- contents: string
Returns void

read

read(): Promise<undefined | string>

- Defined in src/retrieval.ts:18
Returns Promise<undefined | string>

remove

remove(): void

- Defined in src/retrieval.ts:65
Returns void

sync

sync(): undefined | string

- Defined in src/retrieval.ts:27
Returns undefined | string

toString

toString(): string

- Defined in src/retrieval.ts:73
Returns string

write

write(contents: string): void

- Defined in src/retrieval.ts:49
Parameters
- contents: string
Returns void

Generated using TypeDoc