Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Entry

Implements access to CMake cache entries. See api.CacheEntry for more information. This type is immutable.

Hierarchy

  • Entry

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Entry(key: string, value: string, type: CacheEntryType, docs: string, advanced: boolean): Entry

  • Create a new Cache Entry instance. Doesn't modify any files. You probably want to get these from the CMakeCache object instead.

    Parameters

    • key: string

      The name of the entry

    • value: string

      The actual value of the entry. Always a string.

    • type: CacheEntryType

      The actual type of value

    • docs: string

      The DOC string in the cache

    • advanced: boolean

      Whether the entry is ADVANCED

    Returns Entry

Properties

Private _advanced

_advanced: boolean = false

Private _docs

_docs: string = ""

Private _key

_key: string = ""

Private _type

_type: CacheEntryType = api.CacheEntryType.Uninitialized

Private _value

_value: any = null

Accessors

advanced

  • get advanced(): boolean

helpString

  • get helpString(): string

key

  • get key(): string

type

value

  • get value(): any

Methods

as

  • as<T>(): T

Generated using TypeDoc