Type Alias FindNvimOptions

FindNvimOptions: {
    dirs?: string[];
    firstMatch?: boolean;
    minVersion?: string;
    orderBy?: "desc" | "none";
    paths?: string[];
}

Type declaration

  • Optional Readonlydirs?: string[]

    (Optional) Additional directories to search for Nvim executables. These directories will be searched after checking paths but before searching $PATH and other default locations. Useful for including non-standard installation directories.

    Example: ['/opt/neovim/bin', '/home/user/custom/bin']

  • Optional ReadonlyfirstMatch?: boolean

    (Optional) Stop searching after found a valid match

  • Optional ReadonlyminVersion?: string

    (Optional) Minimum nvim version (inclusive) to search for.

    • Example: '0.5.0'
  • Optional ReadonlyorderBy?: "desc" | "none"

    (Optional) Sort order of list of nvim versions.

    • "desc" - (Default) Sort by version in descending order (highest to lowest).
      • Example: ['0.5.0', '0.4.4', '0.4.3']
    • "none" - Order is that of the searched $PATH components.
      • Example: ['0.4.4', '0.5.0', '0.4.3']
  • Optional Readonlypaths?: string[]

    (Optional) Additional specific file paths to check for Nvim executables. These paths will be checked before searching dirs. Useful for allowing users to specify exact Nvim executable locations.

    Example: ['/usr/local/bin/nvim', '/opt/homebrew/bin/nvim']

Settings

Member Visibility