Add types

Author: VincentLanglet

index.d.ts

@@ -0,0 +1,68 @@
+declare namespace i18nextBrowserLanguageDetector {
+  interface DetectorOptions {
+    /**
+     * order and from where user language should be detected
+     */
+    order?: Array<"querystring" | "cookie" | "localStorage" | "navigator" | "htmlTag" | string>;
+
+    /**
+     * keys or params to lookup language from
+     */
+    lookupQuerystring?: string;
+    lookupCookie?: string;
+    lookupLocalStorage?: string;
+
+    /**
+     * cache user language on
+     */
+    caches?: string[];
+
+    /**
+     * languages to not persist (cookie, localStorage)
+     */
+    excludeCacheFor?: string[];
+
+    /**
+     * optional expire and domain for set cookie
+     * @default 10
+     */
+    cookieMinutes?: number;
+    cookieDomain?: string;
+
+    /**
+     * optional htmlTag with lang attribute
+     * @default document.documentElement
+     */
+    htmlTag?: HTMLElement | null;
+  }
+
+  interface CustomDetector {
+    name: string;
+    cacheUserLanguage?(lng: string, options: DetectorOptions): void;
+    lookup(options: DetectorOptions): string | undefined;
+  }
+}
+
+declare class i18nextBrowserLanguageDetector {
+  constructor(services?: any, options?: i18nextBrowserLanguageDetector.DetectorOptions);
+  /**
+   * Adds detector.
+   */
+  addDetector(detector: i18nextBrowserLanguageDetector.CustomDetector): i18nextBrowserLanguageDetector;
+
+  /**
+   * Initializes detector.
+   */
+  init(services?: any, options?: i18nextBrowserLanguageDetector.DetectorOptions): void;
+
+  detect(detectionOrder?: i18nextBrowserLanguageDetector.DetectorOptions): string | undefined;
+
+  cacheUserLanguage(lng: string, caches?: string[]): void;
+
+  type: "languageDetector";
+  detectors: { [key: string]: any };
+  services: any;
+  i18nOptions: any;
+}
+
+export = i18nextBrowserLanguageDetector;

package.json

@@ -3,6 +3,7 @@
   "version": "2.2.4",
   "description": "language detector used in browser environment for i18next",
   "main": "./index.js",
+  "types": "./index.d.ts",
   "jsnext:main": "dist/es/index.js",
   "keywords": [
     "i18next",
@@ -23,6 +24,7 @@
     "babel-plugin-transform-es2015-classes": "6.22.0",
     "babel-preset-es2015": "6.22.0",
     "babel-preset-stage-0": "6.22.0",
+    "dtslint": "^0.4.2",
     "eslint": "2.8.0",
     "eslint-config-airbnb": "7.0.0",
     "mkdirp": "0.5.1",
@@ -31,9 +33,14 @@
     "rollup-plugin-babel": "2.4.0",
     "rollup-plugin-node-resolve": "1.7.1",
     "rollup-plugin-uglify": "0.2.0",
+    "tslint": "^5.12.1",
+    "typescript": "^3.3.1",
     "yargs": "4.6.0"
   },
   "scripts": {
+    "pretest": "npm run test:typescript",
+    "test": "echo 'TODO'",
+    "test:typescript": "tslint --project tsconfig.json",
     "clean": "rimraf dist && mkdirp dist",
     "copy": "cp ./dist/umd/i18nextBrowserLanguageDetector.min.js ./i18nextBrowserLanguageDetector.min.js && cp ./dist/umd/i18nextBrowserLanguageDetector.js ./i18nextBrowserLanguageDetector.js",
     "build:es": "BABEL_ENV=jsnext babel src --out-dir dist/es",

test/typescript/i18next-browser-languageDetector.ts

@@ -0,0 +1,50 @@
+import * as LngDetector from "i18next-browser-languagedetector";
+
+const options: LngDetector.DetectorOptions = {
+  // order and from where user language should be detected
+  order: ["querystring", "cookie", "localStorage", "navigator", "htmlTag"],
+
+  // keys or params to lookup language from
+  lookupQuerystring: "lng",
+  lookupCookie: "i18next",
+  lookupLocalStorage: "i18nextLng",
+
+  // cache user language on
+  caches: ["localStorage", "cookie"],
+  excludeCacheFor: ["cimode"], // languages to not persist (cookie, localStorage)
+
+  // optional expire and domain for set cookie
+  cookieMinutes: 10,
+  cookieDomain: "myDomain",
+
+  // optional htmlTag with lang attribute, the default is:
+  htmlTag: document.documentElement
+};
+
+const customDetector: LngDetector.CustomDetector = {
+  name: "myDetectorsName",
+
+  lookup(options: LngDetector.DetectorOptions) {
+    // options -> are passed in options
+    return "en";
+  },
+
+  cacheUserLanguage(lng: string, options: LngDetector.DetectorOptions) {
+    // options -> are passed in options
+    // lng -> current language, will be called after init and on changeLanguage
+
+    // store it
+  }
+};
+
+const customDetector2: LngDetector.CustomDetector = {
+  name: "myDetectorsName",
+  lookup(options: LngDetector.DetectorOptions) {
+    return undefined;
+  }
+};
+
+const lngDetector = new LngDetector(null, options);
+
+lngDetector.init(options);
+lngDetector.addDetector(customDetector);

tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es5",
+    "lib": ["es6", "dom"],
+    "jsx": "react",
+    "moduleResolution": "node",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noEmit": true,
+    "baseUrl": ".",
+    "paths": { "i18next-browser-languagedetector": ["./index.d.ts"] }
+  },
+  "include": ["./indext.d.ts", "./test/**/*.ts*"]
+}

tslint.json

@@ -0,0 +1,7 @@
+{
+  "defaultSeverity": "error",
+  "extends": "dtslint/dtslint.json",
+  "rules": {
+    "semicolon": false
+  }
+}