File Manipulation APIs
Text Files
Section titled “Text Files”Read File
Section titled “Read File”Modes BrowserWindowsJavaAndroidiOSSAP
Reads the file and returns a string.
Parameters
| Name | Type | Description |
|---|---|---|
$filePath | string | File path of file to be read as text. File path is resolved relative to files folder of the current project. |
$encoding | stringoptional | Encodes the data in file. Defaults to "UTF-8" |
Returns
string | Content of the file |
Raw script
var $contents = _readFile("users.txt");Sahi Pro Classic API _readFile
Write File
Section titled “Write File”Modes BrowserWindowsJavaAndroidiOSSAP
Parameters
| Name | Type | Description |
|---|---|---|
$string | string | String to write to file. |
$filePath | string | File path of file to write into. File path is resolved relative to files folder of the current project. |
$overwrite | booleanoptional | If true, overwrites content. Default is false, which appends at the end of existing content. |
$encoding | stringoptional | Encoding to be used while writing. Default is "UTF-8" |
Raw script
_writeFile("First Line", "out.txt", true); // overwrites content in file_writeFile("Second Line", "out.txt"); // appends second line in fileSahi Pro Classic API _writeFile
Write To File
Section titled “Write To File”Modes BrowserWindowsJavaAndroidiOSSAP
This action is the same as _writeFile. Only the name is different.
Parameters
| Name | Type | Description |
|---|---|---|
$string | string | String to write to file. |
$filePath | string | File path of file to write into. File path is resolved relative to files folder of the current project. |
$overwrite | booleanoptional | If true, overwrites content. Default is false, which appends at the end of existing content. |
$encoding | stringoptional | Encoding to be used while writing. Default is "UTF-8" |
Sahi Pro Classic API _writeToFile
Delete File
Section titled “Delete File”Modes BrowserWindowsJavaAndroidiOSSAP
Parameters
| Name | Type | Description |
|---|---|---|
$filePath | string | File path of file to delete. File path is resolved relative to files folder of the current project. |
Returns
boolean | true if the file was deleted on the filesystem, else false |
Raw script
_deleteFile("out.txt"); // deletes out.txtSahi Pro Classic API _deleteFile
File Exists
Section titled “File Exists”Modes BrowserWindowsJavaAndroidiOSSAP
Parameters
| Name | Type | Description |
|---|---|---|
$filePath | string | File path of file to check. File path is resolved relative to files folder of the current project. |
Returns
boolean | true if the file exists on the filesystem, else false |
Raw script
_fileExists("out.txt"); // returns true if out.txt exists.Sahi Pro Classic API _fileExists
Rename File
Section titled “Rename File”Modes BrowserWindowsJavaAndroidiOSSAP
Renames or moves a file from oldFilePath to newFilePath
Parameters
| Name | Type | Description |
|---|---|---|
$oldFilePath | string | File path of file to rename. File path is resolved relative to files folder of the current project. |
$newFilePath | string | New path of file to write into. File path is resolved relative to files folder of the current project. |
Returns
boolean | true if the file was renamed on the filesystem, else false |
Raw script
_renameFile("original.txt", "renamed.txt"); // renames original.txt to renamed.txt_renameFile("original.txt", "newPath/renamed.txt"); // moves and renames original.txt to newPath/renamed.txtSahi Pro Classic API _renameFile
Copy File
Section titled “Copy File”Modes BrowserWindowsJavaAndroidiOSSAP
copy a file from srcFilePath to destFilePath
Parameters
| Name | Type | Description |
|---|---|---|
$srcFilePath | string | File path of an existing file to copy, must not be null. File path is resolved relative to files folder of the current project. |
$destFilePath | string | File path of the new file, must not be null. File path is resolved relative to files folder of the current project. |
Raw script
_copyFile("source.txt", "dest.txt"); // copies the source.txt into dest.txtSahi Pro Classic API _copyFile
CSV Files
Section titled “CSV Files”CSV Files are a convenient way to store data. Being text based, they can be easily version controlled and diffed. Sahi has APIs to read and write to CSV Files.
Read CSVFile
Section titled “Read CSVFile”Modes BrowserWindowsJavaAndroidiOSSAP
Given a userinfo.csv file with data
Parameters
| Name | Type | Description |
|---|---|---|
$filePath | string | file path to csv file. File path is resolved relative to files folder of the current project. |
$props | objectoptional | Properties to specify for: wordSeparator: string: Word separator character. Defaults to comma. ignoreEmptyRows: boolean: Ignores the empty lines. Defaults to false. includeHeader: boolean: If true, returns the header row also as the first row. Defaults to false. encoding: string: Encodes the data in csv file. Defaults to "UTF-8". |
Returns
two dimensional array of strings | a 2 dimensional array of all values in the csv file |
Raw script
1,Ram,18,Male2,Sam,20,MaleSahi Pro Classic API _readCSVFile
Write CSVFile
Section titled “Write CSVFile”Modes BrowserWindowsJavaAndroidiOSSAP
Writes the 2 dimensional array into the csv file.
Parameters
| Name | Type | Description |
|---|---|---|
$array2d | 2 dimensional array | Two dimensional array of data. |
$filePath | string | File path of csv file to write to. File path is resolved relative to files folder of the current project. |
$overwrite | booleanoptional | If true, overwrites data. Default is false, which appends data. |
$wordSeparator | stringoptional | Word separator character. Defaults to comma. |
$forceQuotes | booleanoptional | Force strings to be inside quotes in the csv file. Defaults to true. |
$padEmptyCells | booleanoptional | Empty cells at the end of rows are not trimmed. Ensures an equal number of commas (separators) in each line. Defaults to false. |
Raw script
var $data = [];$data[0] = ["1", "Ram", 18, "Male"];$data[1] = ["2", "Sam", 20];
_writeCSVFile($data, "data/userinfo.csv", false, ",", true, true);//forces data to be inside quotes with specified word separator and empty cells at the end of rows are not trimmed.//appends data into userinfo.csv.
var $moreData = [["3", "Lak", 30, "Male","Married"]];_writeCSVFile($moreData, "data/userinfo.csv", false, ",", true, true);Sahi Pro Classic API _writeCSVFile

