DevComp/lune-packaging
1
0
Fork 0
mirror of https://github.com/CompeyDev/lune-packaging.git synced 2025-01-09 04:09:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add typedefs for new copy function

Browse source
This commit is contained in:
Filip Tibell 2023-07-20 19:58:18 +02:00
parent b0f23a406b
commit 02132a2eec
No known key found for this signature in database
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/typedefs/FS.luau
View file

@ -253,4 +253,23 @@ return {
@param overwriteOrOptions Options for the target path, such as if should be overwritten if it already exists
]=]
move = function(from: string, to: string, overwriteOrOptions: (boolean | WriteOptions)?) end,
--[=[
@within FS
Copies a file or directory recursively to a new path.
Throws an error if a file or directory already exists at the target path.
This can be bypassed by passing `true` as the third argument, or a dictionary of options.
Refer to the documentation for `WriteOptions` for specific option keys and their values.
An error will be thrown in the following situations:
* The current process lacks permissions to read at `from` or write at `to`.
* Some other I/O error occurred.
@param from The path to copy from
@param to The path to copy to
@param overwriteOrOptions Options for the target path, such as if should be overwritten if it already exists
]=]
copy = function(from: string, to: string, overwriteOrOptions: (boolean | WriteOptions)?) end,
}