Interface FsFileStandalone

Interface for operating on a file opened standalone (without opening a file system

interface FsFileStandalone {
    name: string;
    getBytes(): Promise<FsResult<Uint8Array<ArrayBufferLike>>>;
    getLastModified(): Promise<FsResult<number>>;
    getSize(): Promise<FsResult<number>>;
    getText(): Promise<FsResult<string>>;
    isWritable(): Promise<boolean>;
    write(content: string | Uint8Array<ArrayBufferLike>): Promise<FsVoid>;
}

Index

Properties

Methods

getBytes getLastModified getSize getText isWritable write

Properties

`Readonly`name

name: string

The name of the file

Methods

getBytes

getBytes(): Promise<FsResult<Uint8Array<ArrayBufferLike>>>
Get the content of the file as a byte array

Returns Promise<FsResult<Uint8Array<ArrayBufferLike>>>
- Defined in fs/FsFileStandalone.ts:14

getLastModified

getLastModified(): Promise<FsResult<number>>
Get the last modified time of the file

Returns Promise<FsResult<number>>
- Defined in fs/FsFileStandalone.ts:16

getSize

getSize(): Promise<FsResult<number>>
Get the size of the file

Returns Promise<FsResult<number>>
- Defined in fs/FsFileStandalone.ts:12

getText

getText(): Promise<FsResult<string>>
Get the text content of the file

Returns Promise<FsResult<string>>
- Defined in fs/FsFileStandalone.ts:18

isWritable

isWritable(): Promise<boolean>
If the file is writable. May prompt user for permission

Returns Promise<boolean>
- Defined in fs/FsFileStandalone.ts:10

write

write(content: string | Uint8Array<ArrayBufferLike>): Promise<FsVoid>
Write content to the file if the implementation supports writing, and permission is granted
Parameters
- content: string | Uint8Array<ArrayBufferLike>
Returns Promise<FsVoid>
- Defined in fs/FsFileStandalone.ts:20