| nav-title | file-system How-To |
|---|---|
| title | file-system |
| environment | nativescript |
| description | Examples for using file-system |
| previous_url | /ApiReference/file-system/HOW-TO |
Using the file system requires the FileSystem module.
{%snippet file-system-require%}
The pre-required fs module is used throughout the following code snippets.
{%snippet file-system-normalize%}
Concatenate a path to a file by providing multiple path arguments. {%snippet file-system-multiple-args%}
{%snippet file-system-separator%}
The following example writes some text to a file created for path. It will create a new file or overwrite an existing file. {%snippet file-system-create%}
{%snippet file-system-create-folder%}
The following example writes some text to a file. It will create a new file or overwrite an existing file. {%snippet file-system-write-string%}
{%snippet file-system-create-file%}
{%snippet file-system-get-folder%}
The following example writes some text to a file and then reads it back. {%snippet file-system-example-text%}
{%snippet file-system-read-binary%}
Each app has several well known folders. This is how to access them: {%snippet file-system-known-folders%}
Getting all files and folders within a folder: {%snippet file-system-folders-content%}
Getting all folder entities in array may be slow with large number of files. Enumerating the folder entities would iterate the files one by one without blocking the UI. {%snippet file-system-enum-content%}
{%snippet file-system-parent%}
{%snippet file-system-extension%}
{%snippet file-system-fileexists%}
{%snippet file-system-folderexists%}
{%snippet file-system-renaming%}
{%snippet file-system-renaming-folder%}
To 'delete', 'remove' or 'unlink' a file use the file's remove method: {%snippet file-system-remove-file%}
{%snippet file-system-remove-folder%}
The clear method removes all files within a folder. {%snippet file-system-clear-folder%}