Class File

constructor

• new File(userClient, fileProps, parentServer, dir): File

• Parameters

  • userClient: UserClient
  • fileProps: RawFile
  • parentServer: Server
  • dir: string

  Returns File

Readonlycreated_at

Readonlydir

Readonlyis_file

Readonlyis_symlink

mimetype

Readonlymode

Readonlymode_bits

modified_at

name

ReadonlyparenServer

Readonlysize

compress

• compress(): Promise<void>

• Compress this file

  Returns Promise<void>

copy

• copy(): Promise<void>

• Copy this file
  When copied, 'copy' is appended to the file name.

  Returns Promise<void>

decompress

• decompress(): Promise<void>

• Decompress this file

  Returns Promise<void>

delete

• delete(): Promise<void>

• Delete this file

  Returns Promise<void>

downloadStream

• downloadStream(): Promise<Buffer>

• Download this file

  Returns Promise<Buffer>

downloadUrl

• downloadUrl(): Promise<URL>

• Get a one time download url this file

  Returns Promise<URL>

getContent

• getContent(): Promise<string>

• Get this files content

  Returns Promise<string>

rename

• rename(newName): Promise<void>

• Rename this file

  Parameters

  • newName: string

  Returns Promise<void>

write

• write(content): Promise<string>

• Write new content to this file

  Parameters

  • content: string

  Returns Promise<string>