puter.fs.rename()
Websites Puter Apps Node.js Workers
Renames a file or directory to a new name. This method allows you to change the name of a file or directory in the Puter cloud storage.
Syntax
puter.fs.rename(path, newName)
puter.fs.rename(options)
Parameters
path (string)
The path to the file or directory to rename.
If path is not absolute, it will be resolved relative to the app's root directory.
newName (string)
The new name of the file or directory.
options (Object)
The options for the rename operation. The following options are supported:
path(String) - Path to the file or directory to rename. Required when passing options as the only argument.uid(String) - The UID of the file or directory to rename. Can be used instead ofpath.newName(String) - The new name for the file or directory. Required when passing options as the only argument.
Return value
Returns a promise that resolves to the FSItem object of the renamed file or directory.
Examples
Rename a file
<html>
<body>
<script src="https://js.puter.com/v2/"></script>
<script>
(async () => {
// Create hello.txt
await puter.fs.write('hello.txt', 'Hello, world!');
puter.print(`"hello.txt" created<br>`);
// Rename hello.txt to hello-world.txt
await puter.fs.rename('hello.txt', 'hello-world.txt')
puter.print(`"hello.txt" renamed to "hello-world.txt"<br>`);
})();
</script>
</body>
</html>