Class CapacitorFileEntryApi

Represents a single file entry from the capacitor file plugin system.

Hierarchy

CapacitorFileEntryApi

Implements

FileEntryLike

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CapacitorFileEntryApi(capacitorFilesystem: CapacitorFilePluginLike, directory: string, filePath: string): CapacitorFileEntryApi

- Defined in capacitor/capacitor-file-entry-api.ts:16
Parameters
- capacitorFilesystem: CapacitorFilePluginLike
- directory: string
- filePath: string
Returns CapacitorFileEntryApi

Properties

Protected Readonly capacitorFilesystem

capacitorFilesystem: CapacitorFilePluginLike

Protected Readonly directory

directory: string

Protected Readonly filePath

filePath: string

Methods

getDirectoryName

getDirectoryName(): string

Implementation of FileEntryLike.getDirectoryName
- Defined in capacitor/capacitor-file-entry-api.ts:53
Get the directory name for this entry

Returns string

getFileName

getFileName(): string

Implementation of FileEntryLike.getFileName
- Defined in capacitor/capacitor-file-entry-api.ts:49
Get the file name for this entry

Returns string

getLastModificationTime

getLastModificationTime(): number

Implementation of FileEntryLike.getLastModificationTime
- Defined in capacitor/capacitor-file-entry-api.ts:65
The last time this entry was edited. This is used to determine which files are the oldest when a rotation happens and all files are full.

Returns number

getSize

getSize(): number

Implementation of FileEntryLike.getSize
- Defined in capacitor/capacitor-file-entry-api.ts:61
The current size in bytes of this entry. Used to determine if the stream needs to rotate to a new entry.

Returns number

read

read(): Promise<ArrayBuffer>

Implementation of FileEntryLike.read
- Defined in capacitor/capacitor-file-entry-api.ts:69
Option to read the entire entry contents from disk. Not actively used in the process, but a nice-to-have when interfacing with entries.

Returns Promise<ArrayBuffer>

refresh

refresh(): Promise<void>

Implementation of FileEntryLike.refresh
- Defined in capacitor/capacitor-file-entry-api.ts:80
Called when the entry should refresh its metadata, including size and last modification time.

Returns Promise<void>

toURL

toURL(): string

Implementation of FileEntryLike.toURL
- Defined in capacitor/capacitor-file-entry-api.ts:57
Absolute path to the entry, typically a native file system URI.

Returns string

write

write(bufferData: ArrayBuffer, overwrite: boolean): Promise<void>

Implementation of FileEntryLike.write
- Defined in capacitor/capacitor-file-entry-api.ts:96
Called when the entry is being overwritten or appened to.

Parameters
- bufferData: ArrayBuffer
- overwrite: boolean
Returns Promise<void>

Static createCacheRotationFiles

createCacheRotationFiles(capacitorFilesystem: CapacitorFilePluginLike, rotationFilesDirectory: string, filenames: string[]): CapacitorFileEntryApi[]

- Defined in capacitor/capacitor-file-entry-api.ts:23
Parameters
- capacitorFilesystem: CapacitorFilePluginLike
- rotationFilesDirectory: string
- filenames: string[]
Returns CapacitorFileEntryApi[]

Static createRotationFiles

createRotationFiles(capacitorFilesystem: CapacitorFilePluginLike, rootDirectory: string, rotationFilesDirectory: string, filenames: string[]): CapacitorFileEntryApi[]

- Defined in capacitor/capacitor-file-entry-api.ts:36
Parameters
- capacitorFilesystem: CapacitorFilePluginLike
- rootDirectory: string
- rotationFilesDirectory: string
- filenames: string[]
Returns CapacitorFileEntryApi[]

Generated using TypeDoc