api.warpꓸfs

Methods

api.warpꓸfs.copy(filePath, newFilePath) → Result

api.warpꓸfs.dirList(dirPath) → Result

api.warpꓸfs.exists(filePath) → Boolean

api.warpꓸfs.fileList(dirPath) → Result

api.warpꓸfs.fileListRecursive(dirPath) → Result

api.warpꓸfs.fileSize(filePath) → Result

api.warpꓸfs.move(oldFilePath, newFilePath) → Result

api.warpꓸfs.parseFilePath(filePath) → Result

api.warpꓸfs.remove(filePath) → Result

api.warpꓸfs.rename(oldFilePath, newFilePath) → Result

Methods description

copy(filePath, newFilePath) → Result

Скопировать файл

Parameters:

Name	Type	Description
filePath	String	Путь до файла подлежащего копированию
newFilePath	String	Путь до нового файла

Return:

Result -

Результат выполнения операции.
В поле value - признак успеха выполнения операции (type Boolean)

dirList(dirPath) → Result

Получить список подкаталогов в каталоге

Parameters:

Name	Type	Description
dirPath	String	Путь до каталога

Return:

Result -

Результат выполнения операции.
В поле value - список путей (type String[])

exists(filePath) → Boolean

Вернуть признак существования файла

Parameters:

Name	Type	Description
filePath	String	Путь до файла

Return:

Boolean -

Признак существования файла

fileList(dirPath) → Result

Получить список файлов в каталоге

Parameters:

Name	Type	Description
dirPath	String	Путь до каталога

Return:

Result -

Результат выполнения операции.
В поле value - список имен файлов (type String[])

fileListRecursive(dirPath) → Result

Получить список файлов и подкаталогов в указанном каталоге и всех вложенных каталогах рекурсивно

Parameters:

Name	Type	Description
dirPath	String	Путь до каталога

Return:

Result -

Результат выполнения операции.
В поле value - список путей (type String[])

fileSize(filePath) → Result

Вернуть размер файла

Parameters:

Name	Type	Description
filePath	String	Путь до файла

Return:

Result -

Результат выполнения операции.
В поле value - размер файла в байтах (type Number)

move(oldFilePath, newFilePath) → Result

Переместить файл

Parameters:

Name	Type	Description
oldFilePath	String	Путь до файла подлежащего переносу
newFilePath	String	Путь до нового файла

Return:

Result -

Результат выполнения операции.
В поле value - признак успеха выполнения операции (type Boolean)

parseFilePath(filePath) → Result

Распарсить путь до файла

Parameters:

Name	Type	Description
filePath	String	Путь до файла

Return:

Result -

Результат выполнения операции.
В поле value - информация о файле FilePath

remove(filePath) → Result

Удалить файл

Parameters:

Name	Type	Description
filePath	String	Путь до файла

Return:

Result -

Результат выполнения операции

rename(oldFilePath, newFilePath) → Result

Переименовать файл

Parameters:

Name	Type	Description
oldFilePath	String	Путь до файла подлежащего переименованию
newFilePath	String	Путь до нового файла

Return:

Result -

Результат выполнения операции