Skip to main content
Version: Next

link

function link(oldpath, newpath): Promise<void>;

Create hard link from a file path.

Parameters

ParameterTypeDescription

oldpath

string

Original file path.

newpath

string

New symbolic link that pointing to the original file.

Returns

Promise<void>

It resolves to nothing.

Throws

Throws TypeError if any parameter is invalid. Or throws Error if failed to create hard link from the file.

Example

try {
await Rsvim.fs.link("README.md", "linked-README.md");
Rsvim.cmd.echo(`Created hard link "linked-README.md" pointing to "README.md"`);
} catch (e) {
Rsvim.cmd.echo(`Failed to create hard link pointing to "README.md": ${e}`);
}