Merge pull request #4 from 365talents/feat/add-types

feat: add some basic types
365talents · Oct 11, 2024 · f5d2c9c · f5d2c9c
2 parents ccfc55e + 46ae46f
commit f5d2c9c
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,19 @@
+// https://github.com/jan-rus/country-in-text-detector/
+declare module 'country-in-text-detector' {
+  type CountryResult = {
+    iso3166: string;
+    name: string;
+    type: 'country';
+    matches: string[];
+  };
+
+  type CityResult = {
+    iso3166: string;
+    name: string;
+    countryName: string;
+    type: 'city';
+    matches: string[];
+  };
+
+  export function detect(text: string): Array<CountryResult | CityResult>;
+}