Class: abstract CSpellConfigFile

Defined in: packages/cspell-config-lib/dist/CSpellConfigFile.d.ts:27

Implements

• ICSpellConfigFile

Constructors

Constructor

new CSpellConfigFile(url): CSpellConfigFile

Defined in: packages/cspell-config-lib/dist/CSpellConfigFile.d.ts:29

Parameters

url

URL

Returns

CSpellConfigFile

Properties

settings

abstract readonly settings: CSpellSettings

Defined in: packages/cspell-config-lib/dist/CSpellConfigFile.d.ts:30

The settings from the config file.

Implementation of

ICSpellConfigFile.settings

---

url

readonly url: URL

Defined in: packages/cspell-config-lib/dist/CSpellConfigFile.d.ts:28

The url of the config file, used to resolve imports.

Implementation of

ICSpellConfigFile.url

Accessors

readonly

Get Signature

get readonly(): boolean

Defined in: packages/cspell-config-lib/dist/CSpellConfigFile.d.ts:32

Indicate that the config file is readonly.

Returns

boolean

Indicate that the config file is readonly.

Implementation of

ICSpellConfigFile.readonly

---

remote

Get Signature

get remote(): boolean

Defined in: packages/cspell-config-lib/dist/CSpellConfigFile.d.ts:34

Indicate that the config file is remote and not associated with a file on disk.

Returns

boolean

Indicate that the config file is remote and not associated with a file on disk.

Implementation of

ICSpellConfigFile.remote

---

virtual

Get Signature

get virtual(): boolean

Defined in: packages/cspell-config-lib/dist/CSpellConfigFile.d.ts:33

Indicate that the config file is virtual and not associated with a file on disk.

Returns

boolean

Indicate that the config file is virtual and not associated with a file on disk.

Implementation of

ICSpellConfigFile.virtual

Methods

addWords()

abstract addWords(words): this

Defined in: packages/cspell-config-lib/dist/CSpellConfigFile.d.ts:31

Parameters

words

string[]

Returns

this