Merge pull request #148 from Shigma/patch-1

Optimize Typings
luckykaiyi · Jan 18, 2020 · 2ecd101 · 2ecd101
2 parents 53c48ca + d3b9de5
commit 2ecd101
Showing 1 changed file with 27 additions and 9 deletions.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1,11 +1,29 @@
 declare module "nodejieba" {
-  export function load(dict: object): void;
-  export function cut(sentence: string, strict?: boolean): any;
-  export function cutHMM(sentence: string): any;
-  export function cutAll(sentence: string): any;
-  export function cutForSearch(sentence: string, strict?: boolean): any;
-  export function tag(sentence: string): any;
-  export function extract(sentence: string, threshold: number): any;
-  export function insertWord(sentence: string): any;
-  export function cutSmall(sentence: string, small: number): any;
+  export interface LoadOptions {
+    dict?: string;
+    hmmDict?: string;
+    userDict?: string;
+    idfDict?: string;
+    stopWordDict?: string;
+  }
+
+  export interface TagResult {
+    word: string;
+    tag: string;
+  }
+
+  export interface ExtractResult {
+    word: string;
+    weight: number;
+  }
+
+  export function load(dict?: LoadOptions): void;
+  export function cut(sentence: string, strict?: boolean): string[];
+  export function cutHMM(sentence: string): string[];
+  export function cutAll(sentence: string): string[];
+  export function cutForSearch(sentence: string, strict?: boolean): string[];
+  export function tag(sentence: string): TagResult[];
+  export function extract(sentence: string, threshold: number): ExtractResult[];
+  export function insertWord(sentence: string): boolean;
+  export function cutSmall(sentence: string, small: number): boolean;
 }