detect-avx 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ben Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,32 @@
+# detect-avx
+
+[![CI](https://badgen.net/github/checks/biw/detect-avx)](https://github.com/biw/detect-avx/actions)
+[![npm version](https://badgen.net/npm/v/detect-avx)](https://www.npmjs.com/package/detect-avx)
+[![npm downloads](https://badgen.net/npm/dt/detect-avx)](https://www.npmjs.com/package/detect-avx)
+
+A Node.js package for detecting AVX instruction set support on x86 processors.
+
+## Installation
+
+```sh
+yarn add detect-avx
+```
+
+## Usage
+
+```typescript
+import detectAvx from "detect-avx";
+
+const result = detectAvx();
+console.log(result); // 'avx2', 'avx', or 'none'
+```
+
+## Return Values
+
+- `'avx2'` - CPU supports AVX2 instructions
+- `'avx'` - CPU supports AVX instructions (but not AVX2)
+- `'none'` - CPU does not support AVX instructions (or running on non-x86 platform like ARM)
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Detects AVX instruction set support on the current CPU.
+ * @returns The highest supported AVX version: 'avx2', 'avx', or 'none'
+ */
+declare function detectAvx(): "avx2" | "avx" | "none";
+
+export { detectAvx as default };

package/dist/index.js

@@ -0,0 +1,2 @@
+import{createRequire as t}from"module";import e from"path";import{fileURLToPath as o}from"url";var r=t(import.meta.url),n=e.dirname(o(import.meta.url)),a=r("node-gyp-build")(e.join(n,".."));function i(){return a.detectAvx()}export{i as default};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { createRequire } from \"node:module\";\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\n\nconst require = createRequire(import.meta.url);\nconst __dirname = path.dirname(fileURLToPath(import.meta.url));\n\ninterface NativeAddon {\n  detectAvx(): \"avx2\" | \"avx\" | \"none\";\n}\n\n// Load the native addon using node-gyp-build\nconst addon: NativeAddon = require(\"node-gyp-build\")(\n  path.join(__dirname, \"..\")\n);\n\n/**\n * Detects AVX instruction set support on the current CPU.\n * @returns The highest supported AVX version: 'avx2', 'avx', or 'none'\n */\nexport default function detectAvx(): \"avx2\" | \"avx\" | \"none\" {\n  return addon.detectAvx();\n}\n"],"mappings":"AAAA,OAAS,iBAAAA,MAAqB,SAC9B,OAAOC,MAAU,OACjB,OAAS,iBAAAC,MAAqB,MAE9B,IAAMC,EAAUH,EAAc,YAAY,GAAG,EACvCI,EAAYH,EAAK,QAAQC,EAAc,YAAY,GAAG,CAAC,EAOvDG,EAAqBF,EAAQ,gBAAgB,EACjDF,EAAK,KAAKG,EAAW,IAAI,CAC3B,EAMe,SAARE,GAAsD,CAC3D,OAAOD,EAAM,UAAU,CACzB","names":["createRequire","path","fileURLToPath","require","__dirname","addon","detectAvx"]}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "detect-avx",
+  "version": "0.0.1",
+  "packageManager": "yarn@4.6.0",
+  "description": "Detect AVX instruction set support on Intel processors",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "prebuilds"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "build:native": "node-gyp rebuild",
+    "clean": "node-gyp clean && rm -rf dist",
+    "lint": "tsc --noEmit",
+    "prebuild": "prebuildify --napi --strip",
+    "test": "vitest run",
+    "prepublishOnly": "yarn build"
+  },
+  "keywords": [
+    "avx",
+    "avx2",
+    "cpu",
+    "simd",
+    "intel",
+    "native",
+    "addon",
+    "napi"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/biw/detect-avx.git"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "node-addon-api": "^8.0.0",
+    "node-gyp-build": "^4.8.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "node-gyp": "^12.1.0",
+    "prebuildify": "^6.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^3.0.0"
+  }
+}