doc: add simple example to rename function

Added a simple example showing how to rename a file. Refs: https://github.com/nodejs/node/issues11135 PR-URL: nodejs#18812 Reviewed-By: Matheus Marchini <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: James M Snell <[email protected]>
jasnell · Aug 17, 2018 · 2552af9 · 2552af9
1 parent 8f6b0bd
commit 2552af9
Showing 1 changed file with 13 additions and 2 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -2238,8 +2238,19 @@ changes:
 * `callback` {Function}
   * `err` {Error}
 
-Asynchronous rename(2). No arguments other than a possible exception are given
-to the completion callback.
+Asynchronously rename file at `oldPath` to the pathname provided
+as `newPath`. In the case that `newPath` already exists, it will
+be overwritten. No arguments other than a possible exception are
+given to the completion callback.
+
+See also: rename(2).
+
+```js
+fs.rename('oldFile.txt', 'newFile.txt', (err) => {
+  if (err) throw err;
+  console.log('Rename complete!');
+});
+```
 
 ## fs.renameSync(oldPath, newPath)
 <!-- YAML