files

files (documentation is a work in progress)

virtuosity.files

Classes

WriteStream

Methods

readFile
writeFile
deleteFile
copyFile
fileExists
createDirectory
getFileExtention
getFileName
getFileNameWithoutExtention
getFiles
getFilePath
getFilePathUpDirectory
deleteFolder
renameFile
renameDirectory

Classes

WriteStream

file write stream

new virtuosity.files.WriteStream(path);

Parameter	Type	Description
`path`	`String`	path

Methods

readFile

virtuosity.files.readFile(path, asyncronous);

Parameter	Type	Description
`path`	`String`	path
`asyncronous`	`Boolean`	(OPTIONAL) read file asyncronously

writeFile

virtuosity.files.writeFile(path, output, asyncronous);

Parameter	Type	Description
`path`	`String`	path
`output`	`String`	output
`asyncronous`	`Boolean`	(OPTIONAL) write file asyncronously

deleteFile

virtuosity.files.deleteFile(path);

Parameter	Type	Description
`path`	`String`	path

copyFile

virtuosity.files.copyFile(path, destination);

Parameter	Type	Description
`path`	`String`	path
`destination`	`String`	desination

fileExists

virtuosity.files.fileExists(path);

Parameter	Type	Description
`path`	`String`	path

createDirectory

virtuosity.files.createDirectory(path);

Parameter	Type	Description
`path`	`String`	path

getFileExtention

virtuosity.files.getFileExtention(path);

Parameter	Type	Description
`path`	`String`	path

getFileName

virtuosity.files.getFileName(path);

Parameter	Type	Description
`path`	`String`	path

getFileNameWithoutExtention

virtuosity.files.getFileNameWithoutExtention(path);

Parameter	Type	Description
`path`	`String`	path

getFiles

virtuosity.files.getFiles(path, path);

Parameter	Type	Description
`path`	`String`	path
`path`	`Int`	depth

getFilePath

virtuosity.files.getFilePath(path);

Parameter	Type	Description
`path`	`String`	path

getFilePathUpDirectory

virtuosity.files.getFilePathUpDirectory(path);

Parameter	Type	Description
`path`	`String`	path

deleteFolder

virtuosity.files.deleteFolder(location);

Parameter	Type	Description
`location`	`String`	location

renameFile

virtuosity.files.renameFile(path);

Parameter	Type	Description
`path`	`String`	path

renameDirectory

virtuosity.files.renameDirectory(path);

Parameter	Type	Description
`path`	`String`	path