Class FileInfo<F>

Type Parameters

F extends object = any

Hierarchy (View Summary)

DataInfo<F>
- FileInfo
  - AudioInfo

Index

Constructors

constructor

new FileInfo<F extends object = any>(
    fullname: string,
    type: string,
    size: number,
    file?: File,
    createdAt?: number,
): FileInfo<F>
Type Parameters
- F extends object = any
Parameters
- fullname: string
- type: string
- size: number
- Optionalfile: File
- OptionalcreatedAt: number
Returns FileInfo<F>
Overrides DataInfo.constructor
- Defined in data-info/file-info.ts:67

Properties

`Protected` `Optional`_attributes

_attributes?: F

`Protected` `Readonly`_createdAt

_createdAt: number = 0

`Protected`_extension

_extension: string

`Protected`_file

_file: undefined | File

`Protected` `Optional`_hash

_hash?: string

`Protected`_name

_name: string

`Protected`_online

_online: boolean = true

`Protected`_size

_size: number

`Protected`_type

_type: string

`Protected` `Optional`_url

_url?: string

Accessors

attributes

get attributes(): undefined | T
Returns undefined | T
Inherited from DataInfo.attributes
- Defined in data-info/data-info.ts:26
set attributes(value: undefined | T): void
Parameters
- value: undefined | T
Returns void
Inherited from DataInfo.attributes
- Defined in data-info/data-info.ts:30

available

get available(): boolean
returns if the file is ready for processing

Returns boolean
- Defined in data-info/file-info.ts:8

createdAt

get createdAt(): number
Returns number
- Defined in data-info/file-info.ts:61

extension

get extension(): string
extension including the dot. (this must contain a dot!)

Returns string
- Defined in data-info/file-info.ts:17

file

get file(): undefined | File
Returns undefined | File
- Defined in data-info/file-info.ts:23
set file(value: undefined | File): void
Parameters
- value: undefined | File
Returns void
- Defined in data-info/file-info.ts:27

fullname

get fullname(): string
Returns string
- Defined in data-info/file-info.ts:51
set fullname(value: string): void
Parameters
- value: string
Returns void
- Defined in data-info/file-info.ts:55

hash

get hash(): undefined | string
Returns undefined | string
Inherited from DirectoryInfo.hash
- Defined in data-info/data-info.ts:36
set hash(value: undefined | string): void
Parameters
- value: undefined | string
Returns void
Inherited from DirectoryInfo.hash
- Defined in data-info/data-info.ts:40

name

get name(): string
Returns string
Inherited from DataInfo.name
- Defined in data-info/data-info.ts:10

online

get online(): boolean
Returns boolean
- Defined in data-info/file-info.ts:43
set online(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in data-info/file-info.ts:47

size

get size(): number
Returns number
Inherited from DataInfo.size
- Defined in data-info/data-info.ts:16
set size(value: number): void
Parameters
- value: number
Returns void
Inherited from DataInfo.size
- Defined in data-info/data-info.ts:20

type

get type(): string
Returns string
Inherited from DataInfo.type
- Defined in data-info/data-info.ts:4

url

get url(): undefined | string
Returns undefined | string
- Defined in data-info/file-info.ts:33
set url(value: undefined | string): void
Parameters
- value: undefined | string
Returns void
- Defined in data-info/file-info.ts:37

Methods

clone

clone(): FileInfo<F>
Returns FileInfo<F>
Overrides DataInfo.clone
- Defined in data-info/file-info.ts:336

getBase64

getBase64(file: File): Promise<string>
Parameters
- file: File
Returns Promise<string>
- Defined in data-info/file-info.ts:327

isMediaFile

isMediaFile(): boolean
Returns boolean
- Defined in data-info/file-info.ts:181

toAny

toAny(): Promise<FileInfoSerialized>
Returns Promise<FileInfoSerialized>
- Defined in data-info/file-info.ts:278

updateContentFromURL

updateContentFromURL(httpClient: any): Promise<string>
Parameters
- httpClient: any
Returns Promise<string>
- Defined in data-info/file-info.ts:306

`Static`escapeFileName

escapeFileName(name: string): string
Parameters
- name: string
Returns string
- Defined in data-info/file-info.ts:140

`Static`extractFileName

extractFileName(fullname: string): { extension: string; name: string }
Parameters
- fullname: string
Returns { extension: string; name: string }
- Defined in data-info/file-info.ts:189

`Static`fromAny

fromAny<F extends object>(object: FileInfoSerialized): FileInfo<F>
Type Parameters
- F extends object
Parameters
- object: FileInfoSerialized
Returns FileInfo<F>
- Defined in data-info/file-info.ts:228

`Static`fromFileObject

fromFileObject<F extends object = any>(file: File): FileInfo<F>
Type Parameters
- F extends object = any
Parameters
- file: File
Returns FileInfo<F>
- Defined in data-info/file-info.ts:81

`Static`fromURL

fromURL<F extends object = any>(
    url: string,
    type?: string,
    name?: string,
    createdAt?: number,
    size?: number,
): FileInfo<F>
creates a FileInfo instance form a URL. It doesn't contain the file itself.
Type Parameters
- F extends object = any
Parameters
- url: string
- Optionaltype: string
- Optionalname: string
- createdAt: number = 0
- Optionalsize: number
Returns FileInfo<F>
- Defined in data-info/file-info.ts:93

`Static`getFileContent

getFileContent(file: File, encoding?: string): Promise<string>
Parameters
- file: File
- Optionalencoding: string
Returns Promise<string>
- Defined in data-info/file-info.ts:249

`Static`getFileFromContent

getFileFromContent(content: string, filename: string, type?: string): File
Parameters
- content: string
- filename: string
- Optionaltype: string
Returns File
- Defined in data-info/file-info.ts:258

`Static`getMimeTypeByExtension

getMimeTypeByExtension(
    extension: string,
):
    | "audio/wav"
    | "audio/mpeg"
    | "audio/ogg"
    | "audio/opus"
    | "video/mp4"
    | "image/png"
    | "image/jpg"
    | "application/pdf"
    | "application/json"
    | "text/plain"
Parameters
- extension: string
Returns
    | "audio/wav"
    | "audio/mpeg"
    | "audio/ogg"
    | "audio/opus"
    | "video/mp4"
    | "image/png"
    | "image/jpg"
    | "application/pdf"
    | "application/json"
    | "text/plain"
- Defined in data-info/file-info.ts:113

`Static`renameFile

renameFile(file: File, newName: string, attributes: any): Promise<File>
Parameters
- file: File
- newName: string
- attributes: any
Returns Promise<File>
- Defined in data-info/file-info.ts:162