cspell-dictionary 9.0.2 → 9.1.1

package/dist/SpellingDictionary/CachingDictionary.d.ts

@@ -1,6 +1,7 @@
 import type { CacheStats } from '../util/AutoCache.js';
 import type { PreferredSuggestion, SearchOptions, SpellingDictionary } from './SpellingDictionary.js';
 import type { SpellingDictionaryCollection } from './SpellingDictionaryCollection.js';
+import type { SuggestOptionsRO } from './SuggestOptions.js';
 interface CallStats {
     name: string;
     id: number;
@@ -20,6 +21,7 @@ export interface CachingDictionary {
     isForbidden(word: string): boolean;
     stats(): CallStats;
     getPreferredSuggestions(word: string): PreferredSuggestion[] | undefined;
+    suggest(word: string, suggestOptions?: SuggestOptionsRO): import('cspell-trie-lib').SuggestionResult[];
 }
 interface LogEntryBase extends SearchOptions {
     time: number;

package/dist/SpellingDictionary/CachingDictionary.js

@@ -28,6 +28,7 @@ class CachedDict {
     isNoSuggestWord = autoCache((word) => this.dict.isNoSuggestWord(word, this.options), DefaultAutoCacheSize);
     isForbidden = autoCache((word) => this.dict.isForbidden(word), DefaultAutoCacheSize);
     getPreferredSuggestions = autoCache((word) => this.dict.getPreferredSuggestions?.(word), DefaultAutoCacheSize);
+    suggest = (word, suggestOptions) => this.dict.suggest(word, suggestOptions);
     stats() {
         return {
             name: this.name,

package/dist/SpellingDictionary/SpellingDictionary.d.ts

@@ -36,11 +36,11 @@ export type HasOptions = SearchOptions;
 export type HasOptionsRO = Readonly<HasOptions>;
 export type IgnoreCaseOption = boolean;
 export interface SpellingDictionaryOptions {
-    repMap?: ReplaceMap;
+    repMap?: ReplaceMap | undefined;
     /**
      * The dictionary is case aware.
      */
-    caseSensitive?: boolean;
+    caseSensitive?: boolean | undefined;
     /**
      * This is a NO Suggest dictionary used for words to be ignored.
      */
@@ -56,7 +56,7 @@ export interface SpellingDictionaryOptions {
      * Extra dictionary information used in improving suggestions
      * based upon locale.
      */
-    dictionaryInformation?: DictionaryInformation;
+    dictionaryInformation?: DictionaryInformation | undefined;
     /**
      * Strip Case and Accents to allow for case insensitive searches and
      * words without accents.

package/dist/SpellingDictionary/SuggestOptions.d.ts

@@ -25,7 +25,7 @@ export interface SuggestOptions {
      */
     includeTies?: boolean | undefined;
     /**
-     * Maximum amount of time to allow for generating suggestions.
+     * Maximum amount of time in milliseconds to allow for generating suggestions.
      */
     timeout?: number | undefined;
 }

package/dist/SpellingDictionary/index.d.ts

@@ -3,7 +3,7 @@ export { createInlineSpellingDictionary } from './createInlineSpellingDictionary
 export { createFailedToLoadDictionary, createSpellingDictionary } from './createSpellingDictionary.js';
 export { createFlagWordsDictionary, createFlagWordsDictionary as createForbiddenWordsDictionary, } from './FlagWordsDictionary.js';
 export { createIgnoreWordsDictionary } from './IgnoreWordsDictionary.js';
-export type { DictionaryDefinitionInline, FindOptions, FindResult, HasOptions, SearchOptions, SpellingDictionary, SpellingDictionaryOptions, } from './SpellingDictionary.js';
+export type { DictionaryDefinitionInline, FindOptions, FindResult, HasOptions, PreferredSuggestion, SearchOptions, SpellingDictionary, SpellingDictionaryOptions, } from './SpellingDictionary.js';
 export { createCollection, SpellingDictionaryCollection } from './SpellingDictionaryCollection.js';
 export { createSpellingDictionaryFromTrieFile } from './SpellingDictionaryFromTrie.js';
 export { createSuggestDictionary } from './SuggestDictionary.js';

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { enableLogging as cacheDictionaryEnableLogging, getLog as cacheDictionaryGetLog } from './SpellingDictionary/CachingDictionary.js';
-export type { CachingDictionary, FindOptions, FindResult, HasOptions, SearchOptions, SpellingDictionary, SpellingDictionaryCollection, SpellingDictionaryOptions, SuggestionCollector, SuggestionResult, SuggestOptions, } from './SpellingDictionary/index.js';
+export type { CachingDictionary, FindOptions, FindResult, HasOptions, PreferredSuggestion, SearchOptions, SpellingDictionary, SpellingDictionaryCollection, SpellingDictionaryOptions, SuggestionCollector, SuggestionResult, SuggestOptions, } from './SpellingDictionary/index.js';
 export { createCachingDictionary, createCollection, createFailedToLoadDictionary, createFlagWordsDictionary, createForbiddenWordsDictionary, createIgnoreWordsDictionary, createInlineSpellingDictionary, createSpellingDictionary, createSpellingDictionaryFromTrieFile, createSuggestDictionary, createSuggestOptions, } from './SpellingDictionary/index.js';
 /**
  * Debugging utilities.

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "9.0.2",
+  "version": "9.1.1",
   "description": "A spelling dictionary library useful for checking words and getting suggestions.",
   "type": "module",
   "sideEffects": false,
@@ -54,14 +54,14 @@
     "node": ">=20"
   },
   "dependencies": {
-    "@cspell/cspell-pipe": "9.0.2",
-    "@cspell/cspell-types": "9.0.2",
-    "cspell-trie-lib": "9.0.2",
+    "@cspell/cspell-pipe": "9.1.1",
+    "@cspell/cspell-types": "9.1.1",
+    "cspell-trie-lib": "9.1.1",
     "fast-equals": "^5.2.2"
   },
   "devDependencies": {
     "gensequence": "^7.0.0",
     "lorem-ipsum": "^2.0.8"
   },
-  "gitHead": "39dbd9ab9b8943a023d9eda7f65f81e822f939b5"
+  "gitHead": "40c6e1a331f38a0c008aacf2cb527270752c35ad"
 }