function symlink

#symlink(target: PathLike,
path: PathLike,
type?: string | null,
): Promise<void>

Creates a symbolic link.

The type argument is only used on Windows platforms and can be one of 'dir', 'file', or 'junction'. If the type argument is not a string, Node.js will autodetect target type and use 'file' or 'dir'. If the target does not exist, 'file' will be used. Windows junction points require the destination path to be absolute. When using 'junction', the target argument will automatically be normalized to absolute path. Junction points on NTFS volumes can only point to directories.

Parameters #

#target: PathLike

#path: PathLike

#type: string | null = 'null'

optional

Return Type #

Promise<void>

Fulfills with undefined upon success.