File related methods
Methods
# static exists(pathopt) → {boolean}
Checks if the given path exists
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
path |
string
|
<optional> |
The file path |
True or false
boolean
# static getSequenceNumber(path)
Gets the number of a frame from an file/image sequence
The number must be right before the extension.
The number must be right before the extension.
Parameters:
| Name | Type | Description |
|---|---|---|
path |
string
|
The path of the frame |
# static move(file, newURI) → {File|null}
Moves a file to a new location
Parameters:
| Name | Type | Description |
|---|---|---|
file |
string
|
File
|
The file |
newURI |
string
|
File
|
The new URI/Path (including file name) |
the new file object, or null if it could not be moved
File
|
null
# static parseCSV(file, delimiteropt, textSeparatoropt) → {Array.<string>|null}
Parses a CSV file
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
file |
File
|
The file | ||
delimiter |
string
|
<optional> |
',' | The delimiter used |
textSeparator |
string
|
<optional> |
'"' | The separator for texts |
The content (a two-dimensionnal Array) or null if the file couldn't be parsed
Array.<string>
|
null
# static parseJSON(file) → {Object|null}
Parses a JSON file
Parameters:
| Name | Type | Description |
|---|---|---|
file |
File
|
The file |
The content or null if the file couldn't be parsed
Object
|
null
# static read(file, encodingopt) → {string}
Reads a whole file and return its content
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
file |
File
|
string
|
The file | ||
encoding |
string
|
<optional> |
'UTF-8' | The text encoding |
The content
string
# static readFirstLine(file) → {string}
Reads the first line of a file and return its content
Parameters:
| Name | Type | Description |
|---|---|---|
file |
File
|
string
|
The file |
The content
string
# static saveDialog(prompt, filteropt, defaultExtensionopt) → {File|null}
Shows the default save file dialog and returns the file selected by the user.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
prompt |
string
|
The prompt text, displayed if the dialog allows a prompt. | ||
filter |
string
|
<optional> |
'' | The file type filter (windows only) |
defaultExtension |
string
|
<optional> |
'' | The default extension |
The file or null if the user cancels
File
|
null
# static saveJSON(obj, file) → {boolean}
Saves a js object to a JSON file
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
Object
|
The object to save |
file |
File
|
string
|
The file or URI |
true if the file has been correctly written
boolean
# static write(file, content, appendopt, encodingopt) → {boolean}
Writes a text file
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
file |
File
|
The file | ||
content |
string
|
The content to write | ||
append |
boolean
|
<optional> |
false | Appends instead of replacing |
encoding |
string
|
<optional> |
'UTF-8' | The text encoding |
true if the file has been correctly written
boolean
# static writeln(file, content, appendopt, encodingopt) → {boolean}
Writes a line in a text file
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
file |
File
|
The file | ||
content |
string
|
The content to write | ||
append |
boolean
|
<optional> |
false | Appends instead of replacing |
encoding |
string
|
<optional> |
'UTF-8' | The text encoding |
true if the file has been correctly written
boolean