@onlabsorg/stilo/test/test-repository/.stilo/node_modules/move-file/index.d.ts

Command line tool for managing olojs document packages

export type Options = {
	/**
	Overwrite existing destination file.

	@default true
	*/
	readonly overwrite?: boolean;

	/**
	The working directory to find source files.

	The source and destination path are relative to this.

	@default process.cwd()
	*/
	readonly cwd?: string;

	/**
	[Permissions](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation) for created directories.

	It has no effect on Windows.

	@default 0o777
	*/
	readonly directoryMode?: number;
};

/**
Move a file asynchronously.

@param sourcePath - The file you want to move.
@param destinationPath - Where you want the file moved.
@returns A `Promise` that resolves when the file has been moved.

@example
```
import {moveFile} from 'move-file';

await moveFile('source/unicorn.png', 'destination/unicorn.png');
console.log('The file has been moved');
```
*/
export function moveFile(sourcePath: string, destinationPath: string, options?: Options): Promise<void>;

/**
Move a file synchronously.

@param sourcePath - The file you want to move.
@param destinationPath - Where you want the file moved.

@example
```
import {moveFileSync} from 'move-file';

moveFileSync('source/unicorn.png', 'destination/unicorn.png');
console.log('The file has been moved');
```
*/
export function moveFileSync(sourcePath: string, destinationPath: string, options?: Options): void;

/**
Rename a file asynchronously.

@param source - The file you want to rename.
@param destination - The name of the renamed file.
@returns A `Promise` that resolves when the file has been renamed.

@example
```
import {renameFile} from 'move-file';

await renameFile('unicorn.png', 'unicorns.png', {cwd: 'source'});
console.log('The file has been renamed');
```
*/
export function renameFile(source: string, destination: string, options?: Options): Promise<void>;

/**
Rename a file synchronously.

@param source - The file you want to rename.
@param destination - The name of the renamed file.

@example
```
import {renameFileSync} from 'move-file';

renameFileSync('unicorn.png', 'unicorns.png', {cwd: 'source'});
console.log('The file has been renamed');
```
*/
export function renameFileSync(source: string, destination: string, options?: Options): void;