feat(types): accepts readonly string[] for candidates param

bent10 · Apr 29, 2022 · 9b31503 · 9b31503
1 parent 77afb0b
commit 9b31503
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -53,7 +53,7 @@ export declare type Options = {
  * @param options - Options for the function.
  * @returns An array of similar words.
  */
-export declare function findSimilar(word: string, candidates: string[], options?: Options): string[];
+export declare function findSimilar(word: string, candidates: readonly string[] | string[], options?: Options): string[];
 /**
  * Suggests similar words in a list of words.
  *
@@ -62,4 +62,4 @@ export declare function findSimilar(word: string, candidates: string[], options?
  * @param options - Options for the function.
  * @returns A string of suggested words.
  */
-export declare function didYouMean(word: string, candidates: string[], options?: Options): string;
+export declare function didYouMean(word: string, candidates: readonly string[] | string[], options?: Options): string;
diff --git a/src/index.ts b/src/index.ts
@@ -61,7 +61,7 @@ export type Options = {
  */
 export function findSimilar(
   word: string,
-  candidates: string[],
+  candidates: readonly string[] | string[],
   options: Options = {}
 ) {
   let { maxScore = 3 } = options
@@ -96,7 +96,7 @@ export function findSimilar(
  */
 export function didYouMean(
   word: string,
-  candidates: string[],
+  candidates: readonly string[] | string[],
   options: Options = {}
 ) {
   const matches = findSimilar(word, candidates, options)