https://github.com/jmealo/is-apple-silicon
A Node.js module for detecting Apple Silicon CPUs and ensuring Node.js binary compatibility, optimized for Docker and native add-on development on macOS.
https://github.com/jmealo/is-apple-silicon
apple arm64 cpu mac macos osx processor rosetta silicon
Last synced: 2 months ago
JSON representation
A Node.js module for detecting Apple Silicon CPUs and ensuring Node.js binary compatibility, optimized for Docker and native add-on development on macOS.
- Host: GitHub
- URL: https://github.com/jmealo/is-apple-silicon
- Owner: jmealo
- License: mit
- Created: 2022-05-05T19:55:52.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-13T00:46:18.000Z (over 2 years ago)
- Last Synced: 2025-09-18T02:20:34.222Z (10 months ago)
- Topics: apple, arm64, cpu, mac, macos, osx, processor, rosetta, silicon
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/is-apple-silicon
- Size: 83 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# is-apple-silicon
This Node.js module provides synchronous utility functions for detecting Apple Silicon CPUs and assessing Node.js binary
compatibility. It is particularly useful for ensuring that `node_modules` with native add-ons are correctly compiled for
the target architecture, especially when working with Docker containers on Macs with Apple Silicon.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [Expected Outputs](#expected-outputs)
- [Testing](#testing)
- [Contributing](#contributing)
## Installation
```bash
npm install is-apple-silicon
```
## Usage
The module exports three functions:
- `isAppleSilicon(forceCheck?)`: Determines if the system has an Apple Silicon CPU.
- `isNodeNative(forceCheck?)`: Checks if Node.js is running natively on the system's architecture.
- `isRosetta(forceCheck?)`: Identifies if the process is running under Rosetta translation on Apple Silicon.
Each function includes an optional forceCheck parameter, set to false by default. When true, this parameter bypasses the cached results and forces a fresh check of os.arch() and os.cpus().
## Examples
### CommonJS
```javascript
const {isAppleSilicon, isNodeNative, isRosetta} = require('is-apple-silicon');
```
### ESM
```javascript
import {isAppleSilicon, isNodeNative, isRosetta} from 'is-apple-silicon';
```
## Expected Outputs
Node.js 16+ is required for Apple Silicon support. Node.js 14 and earlier only supports x86 (it will always
return `false` for `isNodeNative()` on Apple Silicon).
#### On a MacBook Pro with Apple Silicon and Node 14 (no arm64 support):
- `isAppleSilicon() === true`
- `isNodeNative() === false`
- `isRosetta() === true`
#### On MacBook Pro with Apple Silicon and Node 16+ (arm64 support):
- `isAppleSilicon() === true`
- `isNodeNative() === true`
- `isRosetta() === false`
#### On Intel MacBook Pro with Node 16+ (x64):
- `isAppleSilicon() === false`
- `isNodeNative() === true`
- `isRosetta() === false`
#### On a non-Apple machine:
- `isAppleSilicon() === false`
- `isNodeNative() === true`
- `isRosetta() === false`
## Testing
The module includes a test script that can be run with `npm test`.
## Contributing
Contributions are welcome! Please feel free to submit pull requests or open issues for any bugs or feature requests.