Class FileFromDB

Hierarchy

File
- FileFromDB

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FileFromDB(app: App): FileFromDB

Inherited from File.constructor
- Defined in src/data-structures/file.ts:20
Parameters
- app: App
Returns FileFromDB

Properties

app

app: App

Optional data

data: Readable

filename

filename: string

Optional id

id: undefined | string

Optional mime_type

mime_type: undefined | string

Methods

getDataPath

getDataPath(): string

Overrides File.getDataPath
- Defined in src/data-structures/file.ts:125
Returns string

getMimeType

getMimeType(): string

Inherited from File.getMimeType
- Defined in src/data-structures/file.ts:34
Returns string

getStream

getStream(): null | ReadStream

Inherited from File.getStream
- Defined in src/data-structures/file.ts:41
Returns null | ReadStream

getURL

getURL(): string

Inherited from File.getURL
- Defined in src/data-structures/file.ts:49
Returns string

save

save(): Promise<this>

Inherited from File.save
- Defined in src/data-structures/file.ts:92
Returns Promise<this>

toDBEntry

toDBEntry(): FileDBEntry

Inherited from File.toDBEntry
- Defined in src/data-structures/file.ts:79
Returns FileDBEntry

Static fromData

fromData(app: App, buffer: Buffer | string): Promise<File>

Inherited from File.fromData
- Defined in src/data-structures/file.ts:69
Parameters
- app: App
- buffer: Buffer | string
Returns Promise<File>

Static fromID

fromID(app: App, id: string): Promise<FileFromDB>

Inherited from File.fromID
- Defined in src/data-structures/file.ts:53
Parameters
- app: App
- id: string
Returns Promise<FileFromDB>

Static fromPath

fromPath(app: App, path: string): Promise<FileFromPath>

Inherited from File.fromPath
- Defined in src/data-structures/file.ts:62
Parameters
- app: App
- path: string
Returns Promise<FileFromPath>

Generated using TypeDoc