Class File

Hierarchy

File
- FileFromDB
- FileFromPath

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new File(app: App): File

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

Properties

app

app: App

Optional data

data: Readable

Optional filename

filename: undefined | string

Optional id

id: undefined | string

Optional mime_type

mime_type: undefined | string

Methods

getDataPath

getDataPath(): string | null

- Defined in src/data-structures/file.ts:25
Returns string | null

getMimeType

getMimeType(): string

- Defined in src/data-structures/file.ts:34
Returns string

getStream

getStream(): null | ReadStream

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

getURL

getURL(): string

- Defined in src/data-structures/file.ts:49
Returns string

save

save(): Promise<this>

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

toDBEntry

toDBEntry(): FileDBEntry

- Defined in src/data-structures/file.ts:79
Returns FileDBEntry

Static fromData

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

- 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>

- 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>

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

Generated using TypeDoc