Class Context

An interface to represent execution context provided to an Extension

Index

Constructors

Properties

project? styleguide?

Methods

getOption fromJSON

Constructors

constructor

new Context(contextData: ContextData): Context
Parameters
- contextData: ContextData
Returns Context
- Defined in context.ts:29

Properties

`Optional`project

project?: Project

Current project that extension is enabled for.

`Optional`styleguide

styleguide?: Styleguide

Current styleguide that extension is enabled for.

Methods

getOption

getOption(name: string): string | number | boolean
Current value of the option whose name is name.
Parameters
- name: string
  Name of the option to be queried.
Returns string | number | boolean
Value of the option.
- Defined in context.ts:47

`Static`fromJSON

fromJSON(json: string): Context
Creates a Context instance from a JSON string
Parameters
- json: string
  JSON string representing a context
Returns Context
A new Context instance
- Defined in context.ts:57