Class File

Creates a file object, which represents one specific file reference. This File object can afterwards be used to up- and download the file contents or to retrieves and change the files metadata.

The file data can be uploaded and downloaded as:

type	JavaScript type	Description
'arraybuffer'	ArrayBuffer	The content is represented as a fixed-length raw binary data buffer
'blob'	Blob	The content is represented as a simple blob
'json'	object\|array\|string	The file content is represented as json
'text'	string	The file content is represented through the string
'base64'	string	The file content as base64 encoded string
'data-url'	string	A data url which represents the file content

Hierarchy

File

Index

Constructors

constructor

new File(fileOptions: FileOptions): File
Creates a new file object which represents a file at the given id. Data which is provided to the constructor will be uploaded by invoking ()
Parameters
- fileOptions: FileOptions
  
  The fileOptions used to create a new file object, or just the id of the file
Returns File
- Defined in lib/binding/File.ts:292

Properties

`Private` [DATA]

[DATA]: null | FileData = null

`Private` [ID]

[ID]: string

`Private` [METADATA]

[METADATA]: null | FileMetadata = null

db

db: EntityManager = ...

The database connection to use

`Readonly` isFolder

isFolder: boolean

Specifies whether this file is a folder.

Accessors

acl

get acl(): undefined | Acl
The current file acl, only accessible after fetching the metadata or downloading/uploading/providing the file

Returns undefined | Acl
- Defined in lib/binding/File.ts:188

bucket

get bucket(): string
The root bucket of this file

Returns string
- Defined in lib/binding/File.ts:255

createdAt

get createdAt(): undefined | Date
The creation date of the file, only accessible after fetching the metadata or downloading/uploading/providing the eTag

Returns undefined | Date
- Defined in lib/binding/File.ts:209

eTag

get eTag(): undefined | string
The eTag of the file, only accessible after fetching the metadata or downloading/uploading/providing the file

Returns undefined | string
- Defined in lib/binding/File.ts:220

headers

get headers(): {
[name: string]: string;
}
The custom headers of the file, only accessible after fetching the metadata or downloading/uploading/providing the file

Returns {
[name: string]: string;
}
- [name: string]: string
- Defined in lib/binding/File.ts:232

id

get id(): string
The complete id of the file, including folder and name

Returns string
- Defined in lib/binding/File.ts:158

isMetadataLoaded

get isMetadataLoaded(): boolean
Indicates if the metadata are loaded.

Returns boolean
- Defined in lib/binding/File.ts:283

key

get key(): string
The full path under the bucket of this file

Returns string
- Defined in lib/binding/File.ts:262

lastModified

get lastModified(): undefined | Date
The last modified date of the file, only accessible after fetching the metadata or downloading/uploading/providing the eTag

Returns undefined | Date
- Defined in lib/binding/File.ts:197

mimeType

get mimeType(): undefined | string
The mimeType of the file, only accessible after fetching the metadata or downloading/uploading/providing the file

Returns undefined | string
- Defined in lib/binding/File.ts:177

name

get name(): string
The name of the file

Returns string
- Defined in lib/binding/File.ts:170

parent

get parent(): string
The parent folder of the file.

Returns string
- Defined in lib/binding/File.ts:276

path

get path(): string
The full path of the file.

Returns string
- Defined in lib/binding/File.ts:269

size

get size(): undefined | number
The size of the file, only accessible after fetching the metadata or downloading/uploading/providing the file

Returns undefined | number
- Defined in lib/binding/File.ts:244

url

get url(): string
Returns string
- Defined in lib/binding/File.ts:163

Methods

checkAvailable

checkAvailable(): void
Checks whenever metadata are already loaded of the file, throws an error otherwise

Returns

Returns void
- Defined in lib/binding/File.ts:678

conditional

conditional(msg: Message, options: {
force?: boolean;
}): void
Makes the given message a conditional request based on the file metadata
Parameters
- msg: Message
  
  The message to make conditional
- options: {
  force?: boolean;
  }
  
  additional request options
  - Optional force?: boolean
Returns void
- Defined in lib/binding/File.ts:491

`Private` createIdFromOptions

createIdFromOptions(fileOptions: FileIdentifiers & FileData): string
Creates the file id from given options.

Returns
Parameters
- fileOptions: FileIdentifiers & FileData
Returns string
- Defined in lib/binding/File.ts:458

createURL

createURL(authorize?: boolean): Promise<string>
The fully url to the file, can be directly used to link the file, i.e. in link tags ot image sources

Returns
A url with an optional token, to give direct access o the linked resource
Parameters
- Optional authorize: boolean
  
  Authorize the the link with an temporary token, to give authorized access to this protected resource default false if the root bucket is www, true otherwise
Returns Promise<string>
- Defined in lib/binding/File.ts:337

delete

delete(deleteOptions?: {
force?: boolean;
}, doneCallback?: any, failCallback?: any): Promise<File | File[]>
Deletes a file

Returns
A promise which will be fulfilled with this file object, or with a list of all deleted files, if this file is an folder
Parameters
- Optional deleteOptions: {
  force?: boolean;
  }
  
  The delete options
  - Optional force?: boolean
- Optional doneCallback: any
  
  The callback is invoked after the deletion succeed successfully
- Optional failCallback: any
  
  The callback is invoked if any error is occurred
Returns Promise<File | File[]>
- Defined in lib/binding/File.ts:434

download

download(downloadOptions?: {
refresh?: false;
type?: ResponseBodyType;
}, doneCallback?: any, failCallback?: any): Promise<ArrayBuffer | Blob | ReadStream | Json | File>
Download a file and providing it in the requested type

Returns
A promise which will be fulfilled with the downloaded file content
Parameters
- Optional downloadOptions: {
  refresh?: false;
  type?: ResponseBodyType;
  }
  
  The download options
  - Optional refresh?: false
  - Optional type?: ResponseBodyType
- Optional doneCallback: any
  
  The callback is invoked after the download succeed successfully
- Optional failCallback: any
  
  The callback is invoked if any error is occurred
Returns Promise<ArrayBuffer | Blob | ReadStream | Json | File>
- Defined in lib/binding/File.ts:398

`Private` fromHeaders

fromHeaders(headers: {
[header: string]: string;
}): void
Parameters
- headers: {
  [header: string]: string;
  }
  - [header: string]: string
Returns void
- Defined in lib/binding/File.ts:604

fromJSON

fromJSON(json: JsonMap | FileMetadata): void
Deserialize the given JSON file metadata back to this file instance

If the JSON object contains an ID, it must match with this file ID, otherwise an exception is thrown.
Parameters
- json: JsonMap | FileMetadata
  
  The json to deserialize
Returns void
- Defined in lib/binding/File.ts:623

`Private` guessMimeType

guessMimeType(options: FileData & FileMetadata): null | string
Private
Gets the MIME type of given file options.

Returns
Returns the guessed MIME type or null, if it could not be guessed.
Parameters
- options: FileData & FileMetadata
Returns null | string
- Defined in lib/binding/File.ts:583

loadMetadata

loadMetadata(options?: {
refresh?: boolean;
}, doneCallback?: any, failCallback?: any): Promise<File>
Gets the file metadata of a file

Returns
A promise which will be fulfilled with this file
Parameters
- Optional options: {
  refresh?: boolean;
  }
  
  The load metadata options
  - Optional refresh?: boolean
    
    Force a revalidation while fetching the metadata
- Optional doneCallback: any
  
  The callback is invoked after the metadata is fetched
- Optional failCallback: any
  
  The callback is invoked if any error has occurred
Returns Promise<File>
- Defined in lib/binding/File.ts:514

saveMetadata

saveMetadata(options?: {
force?: boolean;
}, doneCallback?: any, failCallback?: any): Promise<File>
Updates the mata data of this file.

Returns
A promise which will be fulfilled with this file
Parameters
- Optional options: {
  force?: boolean;
  }
  
  The save metadata options
  - Optional force?: boolean
    
    force the update and overwrite the existing metadata without validating it
- Optional doneCallback: any
  
  The callback is invoked after the metadata is saved
- Optional failCallback: any
  
  The callback is invoked if any error has occurred
Returns Promise<File>
- Defined in lib/binding/File.ts:543

`Private` setDataOptions

setDataOptions(options: FileData & FileMetadata): void
Private
Validates and sets the file metadata based on the given options
Parameters
- options: FileData & FileMetadata
Returns void
- Defined in lib/binding/File.ts:563

toJSON

toJSON(): JsonMap
Serialize the file metadata of this object to json

Returns
The serialized file metadata as json

Returns JsonMap
- Defined in lib/binding/File.ts:658

upload

upload(uploadOptions?: FileData & FileMetadata & {
force?: boolean;
progress?: ProgressListener;
}, doneCallback?: any, failCallback?: any): Promise<File>
Uploads the file content which was provided in the constructor or by uploadOptions.data

Returns
A promise which will be fulfilled with this file object where the metadata is updated
Parameters
- Optional uploadOptions: FileData & FileMetadata & {
  force?: boolean;
  progress?: ProgressListener;
  }
  
  The upload options
- Optional doneCallback: any
  
  The callback is invoked after the upload succeed successfully
- Optional failCallback: any
  
  The callback is invoked if any error is occurred
Returns Promise<File>
- Defined in lib/binding/File.ts:355

`Static` parseETag

parseETag(eTag?: string): null | string
Parses an E-Tag header

Returns
Returns the parsed E-Tag or null, if it could not be parsed
Parameters
- Optional eTag: string
  
  The E-Tag to parse or something falsy
Returns null | string
- Defined in lib/binding/File.ts:318

Class File

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fileOptions: FileOptions

Returns File

Properties

Private [DATA]

Private [ID]

Private [METADATA]

db

Readonly isFolder

Accessors

acl

Returns undefined | Acl

bucket

Returns string

createdAt

Returns undefined | Date

eTag

Returns undefined | string

headers

Returns { [name: string]: string; }

[name: string]: string

id

Returns string

isMetadataLoaded

Returns boolean

key

Returns string

lastModified

Returns undefined | Date

mimeType

Returns undefined | string

name

Returns string

parent

Returns string

path

Returns string

size

Returns undefined | number

url

Returns string

Methods

checkAvailable

Returns

Returns void

conditional

Parameters

msg: Message

options: { force?: boolean; }

Optional force?: boolean

Returns void

Private createIdFromOptions

Returns

Parameters

fileOptions: FileIdentifiers & FileData

Returns string

createURL

Returns

Parameters

Optional authorize: boolean

Returns Promise<string>

delete

Returns

Parameters

Optional deleteOptions: { force?: boolean; }

Optional force?: boolean

Optional doneCallback: any

Optional failCallback: any

Returns Promise<File | File[]>

download

Returns

`Private` [DATA]

`Private` [ID]

`Private` [METADATA]

`Readonly` isFolder

Returns {
[name: string]: string;
}

options: {
force?: boolean;
}

`Optional` force?: boolean

`Private` createIdFromOptions

`Optional` authorize: boolean

`Optional` deleteOptions: {
force?: boolean;
}

`Optional` force?: boolean

`Optional` doneCallback: any

`Optional` failCallback: any

`Optional` downloadOptions: {
refresh?: false;
type?: ResponseBodyType;
}

`Optional` refresh?: false

`Optional` type?: ResponseBodyType

`Optional` doneCallback: any

`Optional` failCallback: any

`Private` fromHeaders

headers: {
[header: string]: string;
}

`Private` guessMimeType

`Optional` options: {
refresh?: boolean;
}

`Optional` refresh?: boolean

`Optional` doneCallback: any

`Optional` failCallback: any

`Optional` options: {
force?: boolean;
}

`Optional` force?: boolean

`Optional` doneCallback: any

`Optional` failCallback: any

`Private` setDataOptions

`Optional` uploadOptions: FileData & FileMetadata & {
force?: boolean;
progress?: ProgressListener;
}

`Optional` doneCallback: any

`Optional` failCallback: any

`Static` parseETag

`Optional` eTag: string