Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DirectoryContext

State attached to a directory in a workspace. Contains a config object and a state management object.

Hierarchy

  • DirectoryContext

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

config

config: ConfigurationReader

The configuration for the associated directory.

dirPath

dirPath: string

The directory path that this context corresponds to

state

state: StateManager

The state management object associated with the directory.

Accessors

cmakePath

  • get cmakePath(): Promise<string | null>

  • The path to a CMake executable associated with this directory. This should be used over ConfigurationReader.cmakePath because it will do additional path expansion and searching.

    Returns Promise<string | null>

ctestPath

  • get ctestPath(): Promise<string | null>

  • The CTest executable for the directory. See cmakePath for more information.

    Returns Promise<string | null>

Methods

Static createForDirectory

  • Create a context object for the given path to a directory.

    Parameters

    • dir: string

      The directory for which to create a context

    • state: StateManager

      The state that will be associated with the returned context

    Returns DirectoryContext

Generated using TypeDoc