Documentation Github Live site Local frontend

Class

File

File(param0)

File data class

Constructor

# new File(param0)

Parameters:
Name Type Description
param0 object

View Source classes/file.ts, line 14

Classes

File

Methods

# static formatPublicURL(id) → {string}

Formats public URL (for client)

Parameters:
Name Type Description
id SnowflakeString

View Source classes/file.ts, line 395

string

# async static fromDatabase(data, ctx)

Parameters:
Name Type Description
data DBFile | DBFileFull
ctx RequestContext

View Source classes/file.ts, line 318

# async static load(id, ctx) → {Promise.<User>}

Parameters:
Name Type Description
id SnowflakeResolvable
ctx RequestContext

View Source classes/file.ts, line 326

Promise.<User>

# async static newFile(param0) → {Promise.<File>}

Parameters:
Name Type Description
param0 object

file data

View Source classes/file.ts, line 333

file

Promise.<File>

# static search(ctx, options) → {Promise.<Collection.<SnowflakeString, File>>}

Searches files

Parameters:
Name Type Description
ctx RequestContext
options any

View Source classes/file.ts, line 341

Promise.<Collection.<SnowflakeString, File>>

# static searchCount(ctx, options) → {Promise.<number>}

Returns the number of files that match the search

Parameters:
Name Type Description
ctx RequestContext
options any

View Source classes/file.ts, line 349

Promise.<number>

# async delete() → {Promise.<void>}

Deletes file (user)

View Source classes/file.ts, line 363

Promise.<void>

# formatPublicURL() → {string}

Formats public URL (for client)

View Source classes/file.ts, line 382

string

# formatPublicURLWithExt() → {string}

Formats public URL with extension (for client)

View Source classes/file.ts, line 388

string

# formatURL() → {string}

Formats URL (for server)

View Source classes/file.ts, line 376

string

# async hardDelete() → {Promise.<void>}

Hard deletes file (moderator nuke)

View Source classes/file.ts, line 370

Promise.<void>

# toJSON() → {Object}

Creates a JSON-compatible object

View Source classes/file.ts, line 407

Object

# async update() → {Promise.<void>}

Updates file (sync DB)

View Source classes/file.ts, line 356

Promise.<void>

# uploadCommand() → {PutObjectCommand}

Creates S3 upload command

View Source classes/file.ts, line 401

PutObjectCommand