renameSync

Type:Function
Status:stable
Since:1.0.0
Platform:node
@blackbyte.sugar.node.fs

This method allows you to rename a file or directory synchronously.

Params

  1. src*-String

    The source path to moveSync

  2. dest*-String

    The destination path

  3. The settings for the operation*-TRenameSyncSettings} [settings={}]

Return

  1. -String

    The new path

Example

import { renameSync } from '@blackbyte/sugar/fs';
renameSync('my/cool/dir', 'another/place/for/directory');