File.remove

Description

Removes an existing file in the server.

Input / Parameter

NameDescriptionInput TypeDefaultOptionsRequired

fileName

The name of the file to be removed.

Text

-

-

Yes

folder

The folder path of the file. If this input is provided, it will be appended to the storage path.

Text

-

-

No

extra

The stored value that is passed to all the callbacks.

Any

-

-

No

Output

DescriptionOutput Type

Returns the formatted information.

Object

Object

KeyDescriptionOutput Type

success

Boolean value to denote whether the function was executed successfully.

Text

message

The message to print.

Text

data

Any additional message or data to print.

Text

Callback

callback

The action performed if this function runs successfully.

DescriptionOutput Type

Returns an object that contains the file information.

Object

errorCallback

The action performed if this function does not run successfully.

DescriptionOutput Type

Returns an error message.

Text

Video

Coming Soon.

Example

Coming Soon.

Steps

Coming Soon.

Result

Coming Soon.

Last updated