Class StorageFile

Represents a storage file

Hierarchy

ChecksumDependentFile
- StorageFile

Index

Constructors

constructor

Properties

filename

Methods

Constructors

constructor

new StorageFile(storage: Storage, filename: string): StorageFile

Overrides ChecksumDependentFile.constructor
- Defined in files/StorageFile.ts:15
Parameters
- storage: Storage
- filename: string
Returns StorageFile

Properties

Readonly filename

filename: string

The name of the file

Methods

append

append(data: string): Promise<void>

Inherited from File.append
- Defined in files/File.ts:30
Appends content to the end of the file

Parameters
- data: string
  
  The content to append
Returns Promise<void>

clear

clear(): Promise<void>

Inherited from ChecksumDependentFile.clear

Overrides File.clear
- Defined in files/ChecksumDependentFile.ts:28
inheritdoc

Returns Promise<void>

exists

exists(): Promise<boolean>

Inherited from File.exists
- Defined in files/File.ts:46
Returns whether the file exists

Returns Promise<boolean>

read

read(): Promise<string>

Overrides ChecksumDependentFile.read
- Defined in files/StorageFile.ts:39
Decrypts the file content and returns it

Returns Promise<string>

write

write(data: string): Promise<void>

Overrides ChecksumDependentFile.write
- Defined in files/StorageFile.ts:31
Encrypts the data and writes it to the file

Parameters
- data: string
  
  The data to write
Returns Promise<void>

Generated using TypeDoc