Class File

Implements

FileAttributes

Index

Constructors

Properties

created_at dir is_file is_symlink mimetype mode mode_bits modified_at name parenServer size

Methods

compress copy decompress delete downloadStream downloadUrl getContent rename write

Constructors

constructor

new File(
    userClient: UserClient,
    fileProps: RawFile,
    parentServer: Server,
    dir: string,
): File
Parameters
- userClient: UserClient
- fileProps: RawFile
- parentServer: Server
- dir: string
Returns File
- Defined in src/UserClient/File.ts:21

Properties

`Readonly`created_at

created_at: Date

`Readonly`dir

dir: string = '/'

`Readonly`is_file

is_file: boolean

`Readonly`is_symlink

is_symlink: boolean

mimetype

mimetype: string

`Readonly`mode

mode: string

`Readonly`mode_bits

mode_bits: string

modified_at

modified_at: Date

name

name: string

`Readonly`parenServer

parenServer: Server

`Readonly`size

size: number

Methods

compress

compress(): Promise<File>
Compress this file

Returns Promise<File>
- Defined in src/UserClient/File.ts:116

copy

copy(): Promise<void>
Copy this file When copied, 'copy' is appended to the file name.

Returns Promise<void>
- Defined in src/UserClient/File.ts:86

decompress

decompress(): Promise<void>
Decompress this file

Returns Promise<void>
- Defined in src/UserClient/File.ts:123

delete

delete(): Promise<void>
Delete this file

Returns Promise<void>
- Defined in src/UserClient/File.ts:130

downloadStream

downloadStream(): Promise<Buffer<ArrayBufferLike>>
Download this file

Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/UserClient/File.ts:67

downloadUrl

downloadUrl(): Promise<URL>
Get a one time download url this file

Returns Promise<URL>
- Defined in src/UserClient/File.ts:53

getContent

getContent(): Promise<string>
Get this files content

Returns Promise<string>
- Defined in src/UserClient/File.ts:39

rename

rename(newName: string): Promise<void>
Rename this file
Parameters
- newName: string
Returns Promise<void>
- Defined in src/UserClient/File.ts:78

write

write(content: string): Promise<string>
Write new content to this file
Parameters
- content: string
Returns Promise<string>
- Defined in src/UserClient/File.ts:98