feat: types

Author: dangreen

.eslintrc.json

@@ -8,5 +8,8 @@
   },
   "rules": {
     "no-magic-numbers": "off"
-  }
+  },
+  "ignorePatterns": [
+    "index.d.ts"
+  ]
 }

.npmpackagejsonlintrc.json

@@ -0,0 +1,24 @@
+export interface UserAgentRegex {
+  /**
+   * Regular expression to match user agent.
+   */
+  regex: RegExp
+  /**
+   * caniuse-lite compatible browser family name.
+   */
+  family: string
+  /**
+   * Fixed browser version.
+   */
+  version?: [number, number, number]
+  /**
+   * Minimum browser version.
+   */
+  minVersion?: [number, number, number]
+  /**
+   * Maximum browser version.
+   */
+  maxVersion?: [number, number, number]
+}
+
+export declare const regexes: UserAgentRegex[]

index.d.ts

@@ -1,10 +1,5 @@
 /**
- * @typedef UserAgentRegex
- * @property {RegExp} regex - Regular expression to match user agent.
- * @property {string} family - caniuse-lite compatible browser family name.
- * @property {[number, number, number]} [version] - Fixed browser version.
- * @property {[number, number, number]} [minVersion] - Minimum browser version.
- * @property {[number, number, number]} [maxVersion] - Maximum browser version.
+ * @typedef {import('./index.d').UserAgentRegex} UserAgentRegex
  */
 
 /** @type {UserAgentRegex[]} */

index.js

@@ -20,7 +20,11 @@
   "engines": {
     "node": ">=14"
   },
-  "exports": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    "import": "./index.js",
+    "types": "./index.d.ts"
+  },
   "publishConfig": {
     "directory": "package"
   },

package.json

@@ -1,5 +1,5 @@
 /**
- * @typedef {import('../index.js').UserAgentRegex} UserAgentRegex
+ * @typedef {import('../index.d').UserAgentRegex} UserAgentRegex
  */
 
 export const useragents = [