UNPKG

1.28 kBTypeScriptView Raw
1export interface CSpellEnvironmentVariables {
2 /**
3 * Enable logging ALL dictionary requests.
4 * Acceptable values are: 'true', 'false', 't', 'f', 'on', 'off', 'yes', 'no', '1', '0'
5 */
6 CSPELL_ENABLE_DICTIONARY_LOGGING?: string;
7 /**
8 * The path to the dictionary log file.
9 */
10 CSPELL_ENABLE_DICTIONARY_LOG_FILE?: string;
11 /**
12 * A Csv list of fields to log.
13 * Fields:
14 * - time: the time the check was made in milliseconds
15 * - word: the word being checked
16 * - value: the result of the check
17 */
18 CSPELL_ENABLE_DICTIONARY_LOG_FIELDS?: string;
19 CSPELL_GLOB_ROOT?: string;
20}
21export type EnvironmentKeys = keyof CSpellEnvironmentVariables;
22type EnvironmentKeyNames = {
23 [K in EnvironmentKeys]: K;
24};
25export declare const environmentKeys: EnvironmentKeyNames;
26export declare function getEnvironmentVariables(): CSpellEnvironmentVariables;
27export declare function setEnvironmentVariable<K extends EnvironmentKeys>(key: K, value: CSpellEnvironmentVariables[K]): void;
28export declare function getEnvironmentVariable<K extends EnvironmentKeys>(key: K): CSpellEnvironmentVariables[K] | undefined;
29export declare function truthy(value: string | undefined): boolean;
30export {};
31//# sourceMappingURL=environment.d.ts.map
\No newline at end of file