cspell-lib
Version:
A library of useful functions used across various cspell tools.
30 lines • 2.09 kB
TypeScript
import type { DictionaryDefinition, DictionaryDefinitionAugmented, DictionaryDefinitionCustom, DictionaryDefinitionInline, DictionaryDefinitionPreferred, DictionaryDefinitionSimple } from '@cspell/cspell-types';
import type { WeightMap } from 'cspell-trie-lib';
type DictionaryDefinitionCustomUniqueFields = Omit<DictionaryDefinitionCustom, keyof DictionaryDefinitionPreferred>;
export type DictionaryDefinitionInternal = DictionaryFileDefinitionInternal | DictionaryDefinitionInlineInternal | DictionaryDefinitionSimpleInternal;
export type DictionaryDefinitionInlineInternal = DictionaryDefinitionInline & {
/** The path to the config file that contains this dictionary definition */
readonly __source?: string | undefined;
};
export type DictionaryDefinitionSimpleInternal = DictionaryDefinitionSimple & {
/** The path to the config file that contains this dictionary definition */
readonly __source?: string | undefined;
};
export interface DictionaryFileDefinitionInternal extends Readonly<DictionaryDefinitionPreferred>, Readonly<Partial<DictionaryDefinitionCustomUniqueFields>>, Readonly<DictionaryDefinitionAugmented> {
/**
* Optional weight map used to improve suggestions.
*/
readonly weightMap?: WeightMap | undefined;
/** The path to the config file that contains this dictionary definition */
readonly __source?: string | undefined;
}
export interface DictionaryFileDefinitionInternalWithSource extends DictionaryFileDefinitionInternal {
readonly __source: string;
}
export type DictionaryDefinitionInternalWithSource = DictionaryDefinitionInternal & {
readonly __source: string;
};
export declare function isDictionaryDefinitionInlineInternal(def: DictionaryDefinitionInternal | DictionaryDefinitionInline | DictionaryDefinition): def is DictionaryDefinitionInlineInternal;
export declare function isDictionaryFileDefinitionInternal(def: DictionaryDefinitionInternal | DictionaryDefinitionInline | DictionaryDefinition): def is DictionaryFileDefinitionInternal;
export {};
//# sourceMappingURL=InternalDictionaryDef.d.ts.map