fix type declaration bugs, add a few more tests

Author: pimpale

package.json

@@ -53,5 +53,5 @@
     "nyc": "^15.1.0"
   },
   "runkitExampleFilename": "./runkit-example.js",
-  "types": "types"
+  "types": "types/index.d.ts"
 }

types/index.d.ts

@@ -119,15 +119,14 @@ declare module 'wink-nlp' {
     freqTable<T>(tokens: T[]): Array<[token: T, freq: number]>;
     bigrams<T>(tokens: T[]): Array<[T, T]>;
     unique<T>(tokens: T[]): T[];
-    text(tokens: any[]): string;
-    markedUpText(tokens: any[]): string;
   }
 
   // functions for use with document
-  export type TokenItsFunction<OutType> = (index: number, token: Token, cache?: Cache, addons?: ModelAddons) => OutType;
-  export type SpanItsFunction<OutType> = (spanItem?: number[]) => OutType;
-  export type VectorizerItsFunction<OutType> = (tf?: ModelTermFrequencies, idf?: ModelInverseDocumentFrequencies) => OutType;
+  export type TokenItsFunction<OutType> = (index: number, token: Token, cache: Cache, addons: ModelAddons) => OutType;
+  export type SpanItsFunction<OutType> = (spanItem: number[]) => OutType;
+  export type VectorizerItsFunction<OutType> = (tf: ModelTermFrequencies, idf: ModelInverseDocumentFrequencies) => OutType;
   export type ItsFunction<OutType> = TokenItsFunction<OutType> | SpanItsFunction<OutType> | VectorizerItsFunction<OutType>;
+
   export type AsFunction<InType, OutType> = (tokens: InType[]) => OutType;
 
   export interface ItemToken {
@@ -225,7 +224,7 @@ declare module 'wink-nlp' {
     parentDocument(): Document;
     markup(beginMarker: string, endMarker: string): void;
     out(): string;
-    out<T>(itsf: ItsFunction<T>): T[] | string;
+    out<T>(itsf: ItsFunction<T>): T | string;
     entities(): Entities;
     customEntities(): CustomEntities;
     tokens(): Tokens;
@@ -247,7 +246,7 @@ declare module 'wink-nlp' {
     isLexeme(text: string): boolean;
     isOOV(text: string): boolean;
     out(): string;
-    out<T>(itsf: ItsFunction<T>): T[] | string;
+    out<T>(itsf: ItsFunction<T>): T | string;
     sentences(): Sentences;
     tokens(): Tokens;
     printTokens(): void;

types/test.ts

@@ -1,13 +1,18 @@
 import winkNlp, {
-    Sentences,
-    CustomEntities,
-    SelectedCustomEntities,
-    Entities,
-    SelectedEntities,
-    Tokens,
-    SelectedTokens,
-    ItsFunction,
-    AsFunction,
+  Sentences,
+  CustomEntities,
+  SelectedCustomEntities,
+  Entities,
+  SelectedEntities,
+  Tokens,
+  SelectedTokens,
+  ItemCustomEntity,
+  ItemEntity,
+  ItemSentence,
+  ItemToken,
+  Document,
+  ItsFunction,
+  AsFunction,
 } from 'wink-nlp';
 import model from 'wink-eng-lite-web-model';
 
@@ -35,9 +40,37 @@ customEntities.out(its.value, as.array);
 // $ExpectType string[]
 customEntities.out(its.value, as.array);
 
-type OutApplicable = Sentences | CustomEntities | SelectedCustomEntities | Entities | SelectedEntities | Tokens | SelectedTokens;
+type ColOutApplicable = Sentences | CustomEntities | SelectedCustomEntities | Entities | SelectedEntities | Tokens | SelectedTokens;
 
-// $ExpectType <T, U>(toOut: OutApplicable, itsf: ItsFunction<T>, asf: AsFunction<T, U>) => U
-function myOut<T, U>(toOut: OutApplicable, itsf: ItsFunction<T>, asf: AsFunction<T, U>): U {
+// collection out
+// $ExpectType <T, U>(toOut: ColOutApplicable, itsf: ItsFunction<T>, asf: AsFunction<T, U>) => U
+function myColOut<T, U>(toOut: ColOutApplicable, itsf: ItsFunction<T>, asf: AsFunction<T, U>): U {
   return (toOut.out(itsf, asf) as any) as U;
 }
+
+// $ExpectType string[] | boolean[] | [token: boolean, freq: number][]
+customEntities.out(its.contractionFlag, as.freqTable);
+
+// $ExpectType [token: boolean, freq: number][]
+myColOut(customEntities, its.contractionFlag, as.freqTable);
+
+// $ExpectType string[]
+doc.tokens().out();
+
+// $ExpectType string[] | boolean[]
+doc.tokens().out(its.abbrevFlag);
+
+// run out on item types
+type ItemOutApplicable = ItemCustomEntity | ItemEntity | ItemSentence | ItemToken | Document;
+
+// item out
+// $ExpectType <T>(toOut: ItemOutApplicable, itsf: ItsFunction<T>) => T
+function myItemOut<T>(toOut: ItemOutApplicable, itsf: ItsFunction<T>): T {
+  return (toOut.out(itsf) as any) as T;
+}
+
+// $ExpectType string | number[]
+doc.out(its.span);
+
+// $ExpectType number[]
+myItemOut(doc, its.span);