ClassFileInfo

Hierarchy (view full)

DataInfo
- FileInfo
  - AudioInfo

Index

Constructors

Properties

_extension _file _hash? _name _size _type _url?

Accessors

attributes available createdAt extension file fullname hash name online size type url

Methods

getBase64 isMediaFile toAny updateContentFromURL escapeFileName extractFileName fromAny fromFileObject fromURL getFileContent getFileFromContent getMimeTypeByExtension renameFile

Constructors

constructor

new FileInfo(fullname, type, size, file?, createdAt?): FileInfo
Parameters
- fullname: string
- type: string
- size: number
- Optionalfile: File
- OptionalcreatedAt: number
Returns FileInfo
Overrides DataInfo.constructor
- Defined in data-info/file-info.ts:69

Properties

`Protected`_extension

_extension: string

`Protected`_file

_file: undefined | File

`Protected` `Optional`_hash

_hash?: string

`Protected`_name

_name: string

`Protected`_size

_size: number

`Protected`_type

_type: string

`Protected` `Optional`_url

_url?: string

Accessors

attributes

get attributes(): any
Returns any
Inherited from DataInfo.attributes
- Defined in data-info/data-info.ts:26
set attributes(value): void
Parameters
- value: any
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:63

extension

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

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

file

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

fullname

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

hash

get hash(): undefined | string
Returns undefined | string
Inherited from DataInfo.hash
- Defined in data-info/data-info.ts:36
set hash(value): void
Parameters
- value: undefined | string
Returns void
Inherited from DataInfo.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:45
set online(value): void
Parameters
- value: boolean
Returns void
- Defined in data-info/file-info.ts:49

size

get size(): number
Returns number
Inherited from DataInfo.size
- Defined in data-info/data-info.ts:16
set size(value): 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:35
set url(value): void
Parameters
- value: undefined | string
Returns void
- Defined in data-info/file-info.ts:39

Methods

getBase64

getBase64(file): any
Parameters
- file: File
Returns any
- Defined in data-info/file-info.ts:326

isMediaFile

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

toAny

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

updateContentFromURL

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

`Static`escapeFileName

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

`Static`extractFileName

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

`Static`fromAny

fromAny(object): FileInfo
Parameters
- object: any
Returns FileInfo
- Defined in data-info/file-info.ts:230

`Static`fromFileObject

fromFileObject(file): FileInfo
Parameters
- file: File
Returns FileInfo
- Defined in data-info/file-info.ts:83

`Static`fromURL

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

`Static`getFileContent

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

`Static`getFileFromContent

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

`Static`getMimeTypeByExtension

getMimeTypeByExtension(extension):
    | "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:115

`Static`renameFile

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