Options
All
  • Public
  • Public/Protected
  • All
Menu

Module nextra/createSymlink

Index

Type aliases

Functions

Type aliases

SymLinkType

SymLinkType: "dir" | "file" | "junction"

The type of symlink you are creating:

  • dir
  • file
  • junction
memberof

fsn/nextra

Functions

createSymlink

  • createSymlink(source: string, destination: string, atomic?: boolean): Promise<void>
  • createSymlink(source: string, destination: string, type?: SymLinkType, atomic?: boolean): Promise<void>

  • Creates a soft file link, making all folders required to satisfy the given file path.

    function

    createSymlink

    memberof

    fsn/nextra

    Parameters

    • source: string

      The source path of the file

    • destination: string

      The destination path of the file

    • Optional atomic: boolean

      Whether the operation should run atomically

    Returns Promise<void>

  • Parameters

    • source: string
    • destination: string
    • Optional type: SymLinkType
    • Optional atomic: boolean

    Returns Promise<void>

Const ensureSymlink

  • ensureSymlink(source: string, destination: string, atomic?: boolean): Promise<void>
  • ensureSymlink(source: string, destination: string, type?: SymLinkType, atomic?: boolean): Promise<void>

Generated using TypeDoc