File

The File Module allows an application to write & read UTF-8 text data. The module is design to allow collection and storage of data for use in later processes. Coupled with the File Sharing feature, the files created can be shared to users.

Writing Data

An example below takes a content from a remote host i.e. an API using the Fetch Module and saving the content.

//! Fetch the content from the API
fetch GET,https://api.host.com,content-type=application/json&authentication=bearer token,param1=data1&param2=data2;
variable fetchResult = @@;

//! If the fetch is unsuccessful, terminate the application.
condition find_in fetchResult Error;
    varlog An error has occured: {$fetchResult};
    exit!;
end_if;

//! Transform the data
ai <transformation prompt> {$fetchResult};
variable transformedData = @@;

//! Save the data to file with random file name (UUID)
prop null, {$transformedData};
variable fileId = @@;
varlog File is saved: {$fileId};

Check if File Exists

To check if a file with a given file ID exists.

variable fileId = <file in the system>;
exists {$fileId};
variable result = @@;
condition equal_to result null;
    varlog File does not exists;
else_condition;
    varlog File exists;
end_if;

Reading Data

To read data, use the peak method.

variable fileId = <file in the system>;
peak {$fileId};
variable contents = @@;
varlog Contents: {$contents}; 

Overwriting File

To overwrite the contents of a file with a given file ID.

variable fileId = <name of file in the system>;
fix {$fileId}, <new file content>;

Append To File

To append the contents to an existing file with a given file ID.

variable fileId = <name of file in the system>;
glue {$fileId}, <file content>;

Deleting File

To delete files, use the axe method.

// Delete one file in the system
axe <name of the file in the system>;

// Delete all files
axe all;

Questions?

Let us know on [e-mail].