---
description: Run a full Node.js runtime in your Capacitor app on Android and iOS. Use npm packages and exchange messages with the Node.js engine.
title: Capacitor Node.js Plugin for Android & iOS - Capawesome
image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/nodejs.png
---
[Skip to content ](#capawesomecapacitor-nodejs)
[🔐 Introducing the **Capacitor Vault** plugin — store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/)
* [ SDKs ](/docs/sdks/)
* [ Formbricks ](/docs/sdks/capacitor/formbricks/)
* [ Geocoder ](/docs/sdks/capacitor/geocoder/)
* [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/)
* [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/)
* [ libSQL ](/docs/sdks/capacitor/libsql/)
* [ Live Update ](/docs/sdks/capacitor/live-update/)
* [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/)
* [ Media Session ](/docs/sdks/capacitor/media-session/)
* [ ML Kit ](/docs/sdks/capacitor/mlkit/)
* [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/)
* [ NFC ](/docs/sdks/capacitor/nfc/)
* Node.js [ Node.js ](/docs/sdks/capacitor/nodejs/)
* [ iOS ](#ios)
* [ Configuration ](#configuration)
* [ Demo ](#demo)
* [ Usage ](#usage)
* [ API ](#api)
* [ Type Aliases ](#type-aliases)
* [ Limitations ](#limitations)
* [ FAQ ](#faq)
* [ Changelog ](#changelog)
* [ License ](#license)
* [ OAuth ](/docs/sdks/capacitor/oauth/)
* [ Pedometer ](/docs/sdks/capacitor/pedometer/)
* [ Photo Editor ](/docs/sdks/capacitor/photo-editor/)
* [ PostHog ](/docs/sdks/capacitor/posthog/)
* [ Printer ](/docs/sdks/capacitor/printer/)
* [ Purchases ](/docs/sdks/capacitor/purchases/)
* [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/)
* [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/)
* [ Screenshot ](/docs/sdks/capacitor/screenshot/)
* [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/)
* [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/)
* [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/)
* [ Share Target ](/docs/sdks/capacitor/share-target/)
* [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/)
* [ SQLite ](/docs/sdks/capacitor/sqlite/)
* [ Superwall ](/docs/sdks/capacitor/superwall/)
* [ Torch ](/docs/sdks/capacitor/torch/)
* [ Vault ](/docs/sdks/capacitor/vault/)
* [ Wifi ](/docs/sdks/capacitor/wifi/)
* [ Zip ](/docs/sdks/capacitor/zip/)
* [ Cordova ](/docs/sdks/cordova/)
* [ Cloud ](/docs/cloud/)
* [ Integrations ](/docs/cloud/live-updates/integrations/)
* Concepts
* Reference
* [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/)
* [ FAQ ](/docs/cloud/live-updates/faq/)
* [ Native Builds ](/docs/cloud/native-builds/)
* [ Set Up Environments ](/docs/cloud/native-builds/environments/)
* [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/)
* [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/)
* [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/)
* [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/)
* [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/)
* [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/)
* [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/)
* [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/)
* [ Build without Git ](/docs/cloud/native-builds/build-without-git/)
* [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/)
* [ Integrations ](/docs/cloud/native-builds/integrations/)
* Reference
* [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/)
* [ FAQ ](/docs/cloud/native-builds/faq/)
* [ App Store Publishing ](/docs/cloud/app-store-publishing/)
* [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/)
* [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/)
* [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/)
* [ FAQ ](/docs/cloud/app-store-publishing/faq/)
* [ Automations ](/docs/cloud/automations/)
* [ Reference ](/docs/cloud/automations/reference/)
* [ Troubleshooting ](/docs/cloud/automations/troubleshooting/)
* [ FAQ ](/docs/cloud/automations/faq/)
* [ Assist ](/docs/cloud/assist/)
* [ CLI ](/docs/cloud/cli/)
* APIs and SDKs
* [ Webhooks ](/docs/cloud/webhooks/)
* [ Integrations ](/docs/cloud/integrations/)
* Account
* [ Organization ](/docs/cloud/organizations/)
* [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/)
* [ Audit Logs ](/docs/cloud/organizations/audit-logs/)
* [ Billing ](/docs/cloud/organizations/billing/)
* [ License Keys ](/docs/cloud/license-keys/)
* [ AI ](/docs/ai/)
* [ Insiders ](/docs/insiders/)
* [ Billing & Plans ](/docs/insiders/billing-and-plans/)
* [ FAQ ](/docs/insiders/faq/)
* [ License ](https://capawesome.io/legal/eula/)
* [ Support ](/docs/support/)
* [ Contributing ](/docs/contributing/)
* Contributing code
* [ Code of Conduct ](/docs/contributing/code-of-conduct/)
* [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion)
* [ Blog ](/blog/)
* Categories
* [ iOS ](#ios)
* [ Configuration ](#configuration)
* [ Demo ](#demo)
* [ Usage ](#usage)
* [ API ](#api)
* [ Type Aliases ](#type-aliases)
* [ Limitations ](#limitations)
* [ FAQ ](#faq)
* [ Changelog ](#changelog)
* [ License ](#license)
# @capawesome/capacitor-nodejs[¶](#capawesomecapacitor-nodejs "Permanent link")
Capacitor plugin for running [Node.js](https://nodejs.org/) in mobile apps.[1](#fn:1)[2](#fn:2)
[  ](https://cloud.capawesome.io/)
## Features[¶](#features "Permanent link")
We are proud to offer one of the most complete and feature-rich Capacitor plugins for running Node.js in mobile apps. Here are some of the key features:
* 🖥️ **Cross-platform**: Supports Android and iOS.
* 🚀 **Node.js runtime**: Embeds a complete Node.js runtime based on [Node.js for Mobile Apps](https://github.com/nodejs-mobile/nodejs-mobile).
* 🧵 **Background thread**: Runs the Node.js engine on a dedicated background thread to avoid blocking the UI.
* 🔁 **Bidirectional communication**: Event-based message passing between the Capacitor app and the Node.js runtime.
* 📦 **npm ecosystem**: Use npm packages that are not browser-compatible and rely on Node.js core modules.
* 🛠️ **Configurable**: Start the Node.js runtime automatically or manually with custom arguments, environment variables and script.
* 🔁 **Up-to-date**: Always supports the latest Capacitor version.
Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look!
## Newsletter[¶](#newsletter "Permanent link")
Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).
## Compatibility[¶](#compatibility "Permanent link")
| Plugin Version | Capacitor Version | Status |
| -------------- | ----------------- | -------------- |
| 0.0.x | \>=8.x.x | Active support |
## Installation[¶](#installation "Permanent link")
You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command:
`[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins
`
Then use the following prompt:
`` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-nodejs` plugin in my project.
``
If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below:
`[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-nodejs
[](#%5F%5Fcodelineno-2-2)npx cap sync
`
**Attention**: This plugin embeds the [Node.js for Mobile Apps](https://github.com/nodejs-mobile/nodejs-mobile) runtime binaries. The binaries are not included in the npm package but downloaded on demand: the Android binaries are downloaded by the Gradle build and the iOS binaries are downloaded during `npm install` (only on macOS). Set the `CAPACITOR_NODEJS_SKIP_DOWNLOAD` environment variable to `1` to skip the iOS download.
### Android[¶](#android "Permanent link")
#### Variables[¶](#variables "Permanent link")
If needed, you can define the following project variables in your app's `variables.gradle` file to change the default version of the runtime:
* `$nodejsMobileVersion` version of the Node.js for Mobile Apps runtime (default: `18.20.4-capawesome.1`, a [16 KB page size compatible build](https://github.com/capawesome-team/nodejs-mobile/releases))
* `$nodejsMobileAndroidUrl` download URL of the Android runtime binaries (default: GitHub release of `$nodejsMobileVersion`)
* `$nodejsMobileAndroidSha256` SHA-256 checksum of the Android runtime binaries download (default: checksum of `$nodejsMobileVersion`)
### iOS[¶](#ios "Permanent link")
This plugin currently only supports **Swift Package Manager**. CocoaPods is not supported.
If you install dependencies with disabled lifecycle scripts (e.g. `npm install --ignore-scripts`), the iOS runtime binaries are not downloaded automatically. In this case, run the download script manually before building your app:
`[](#%5F%5Fcodelineno-3-1)node node_modules/@capawesome/capacitor-nodejs/scripts/postinstall.js
`
## Configuration[¶](#configuration "Permanent link")
| Prop | Type | Description | Default | Since |
| ------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----- |
| **nodeDir** | string | The directory of the Node.js project, relative to the Capacitor webDir. Only available on Android and iOS. | 'nodejs' | 0.0.1 |
| **startMode** | 'manual' \| 'auto' | The start mode of the Node.js runtime. If set to auto, the Node.js runtime starts automatically when the app is launched. If set to manual, the Node.js runtime must be started manually using the start(...) method. Only available on Android and iOS. | 'auto' | 0.0.1 |
### Examples[¶](#examples "Permanent link")
In `capacitor.config.json`:
`[](#%5F%5Fcodelineno-4-1){
[](#%5F%5Fcodelineno-4-2) "plugins": {
[](#%5F%5Fcodelineno-4-3) "Nodejs": {
[](#%5F%5Fcodelineno-4-4) "nodeDir": 'custom-nodejs',
[](#%5F%5Fcodelineno-4-5) "startMode": 'manual'
[](#%5F%5Fcodelineno-4-6) }
[](#%5F%5Fcodelineno-4-7) }
[](#%5F%5Fcodelineno-4-8)}
`
In `capacitor.config.ts`:
`[](#%5F%5Fcodelineno-5-1)///
[](#%5F%5Fcodelineno-5-2)
[](#%5F%5Fcodelineno-5-3)import { CapacitorConfig } from '@capacitor/cli';
[](#%5F%5Fcodelineno-5-4)
[](#%5F%5Fcodelineno-5-5)const config: CapacitorConfig = {
[](#%5F%5Fcodelineno-5-6) plugins: {
[](#%5F%5Fcodelineno-5-7) Nodejs: {
[](#%5F%5Fcodelineno-5-8) nodeDir: 'custom-nodejs',
[](#%5F%5Fcodelineno-5-9) startMode: 'manual',
[](#%5F%5Fcodelineno-5-10) },
[](#%5F%5Fcodelineno-5-11) },
[](#%5F%5Fcodelineno-5-12)};
[](#%5F%5Fcodelineno-5-13)
[](#%5F%5Fcodelineno-5-14)export default config;
`
## Demo[¶](#demo "Permanent link")
A working example can be found [here](https://github.com/capawesome-team/capacitor-plugins/tree/main/packages/nodejs/example).
## Usage[¶](#usage "Permanent link")
The plugin runs the Node.js project located in the `nodejs` directory (see the `nodeDir` configuration option) inside your Capacitor `webDir`. Make sure your web build outputs the Node.js project to this directory, for example by placing it in the `public` directory of your web project:
`[](#%5F%5Fcodelineno-6-1)my-app
[](#%5F%5Fcodelineno-6-2)├── capacitor.config.json // webDir: 'dist'
[](#%5F%5Fcodelineno-6-3)└── src
[](#%5F%5Fcodelineno-6-4) └── public
[](#%5F%5Fcodelineno-6-5) └── nodejs
[](#%5F%5Fcodelineno-6-6) ├── package.json
[](#%5F%5Fcodelineno-6-7) └── index.js
`
The `package.json` file of the Node.js project defines the script file to run in the `main` field:
`[](#%5F%5Fcodelineno-7-1){
[](#%5F%5Fcodelineno-7-2) "name": "nodejs-project",
[](#%5F%5Fcodelineno-7-3) "version": "1.0.0",
[](#%5F%5Fcodelineno-7-4) "main": "index.js"
[](#%5F%5Fcodelineno-7-5)}
`
Inside the script file (`index.js` in this example), the built-in `bridge` module provides the communication channel to the Capacitor app:
`[](#%5F%5Fcodelineno-8-1)const { app, channel } = require('bridge');
[](#%5F%5Fcodelineno-8-2)
[](#%5F%5Fcodelineno-8-3)// Receive messages from the Capacitor app.
[](#%5F%5Fcodelineno-8-4)channel.on('my-event', (...args) => {
[](#%5F%5Fcodelineno-8-5) // Send messages to the Capacitor app.
[](#%5F%5Fcodelineno-8-6) channel.post('my-response', 'Hello from Node.js!');
[](#%5F%5Fcodelineno-8-7)});
[](#%5F%5Fcodelineno-8-8)
[](#%5F%5Fcodelineno-8-9)// Get a writable directory for persistent file storage.
[](#%5F%5Fcodelineno-8-10)const dataDir = app.datadir();
[](#%5F%5Fcodelineno-8-11)
[](#%5F%5Fcodelineno-8-12)// Listen for app lifecycle events.
[](#%5F%5Fcodelineno-8-13)app.on('pause', pauseLock => {
[](#%5F%5Fcodelineno-8-14) pauseLock.release();
[](#%5F%5Fcodelineno-8-15)});
[](#%5F%5Fcodelineno-8-16)app.on('resume', () => {});
`
**Attention**: The Node.js project directory may be overwritten during app updates. Store persistent data in the directory returned by `app.datadir()`.
In your Capacitor app, you can then use the plugin to start the Node.js runtime and exchange messages with it:
`` [](#%5F%5Fcodelineno-9-1)import { Nodejs } from '@capawesome/capacitor-nodejs';
[](#%5F%5Fcodelineno-9-2)
[](#%5F%5Fcodelineno-9-3)const isReady = async () => {
[](#%5F%5Fcodelineno-9-4) const { ready } = await Nodejs.isReady();
[](#%5F%5Fcodelineno-9-5) return ready;
[](#%5F%5Fcodelineno-9-6)};
[](#%5F%5Fcodelineno-9-7)
[](#%5F%5Fcodelineno-9-8)const send = async () => {
[](#%5F%5Fcodelineno-9-9) await Nodejs.send({
[](#%5F%5Fcodelineno-9-10) eventName: 'my-event',
[](#%5F%5Fcodelineno-9-11) args: ['Hello from Capacitor!'],
[](#%5F%5Fcodelineno-9-12) });
[](#%5F%5Fcodelineno-9-13)};
[](#%5F%5Fcodelineno-9-14)
[](#%5F%5Fcodelineno-9-15)const start = async () => {
[](#%5F%5Fcodelineno-9-16) // Only available if the `startMode` configuration option is set to `manual`.
[](#%5F%5Fcodelineno-9-17) await Nodejs.start({
[](#%5F%5Fcodelineno-9-18) args: ['--option', 'value'],
[](#%5F%5Fcodelineno-9-19) env: { MY_ENV_VAR: 'value' },
[](#%5F%5Fcodelineno-9-20) script: 'custom-main.js',
[](#%5F%5Fcodelineno-9-21) });
[](#%5F%5Fcodelineno-9-22)};
[](#%5F%5Fcodelineno-9-23)
[](#%5F%5Fcodelineno-9-24)const addReadyListener = async () => {
[](#%5F%5Fcodelineno-9-25) await Nodejs.addListener('ready', () => {
[](#%5F%5Fcodelineno-9-26) console.log('The Node.js runtime is ready.');
[](#%5F%5Fcodelineno-9-27) });
[](#%5F%5Fcodelineno-9-28)};
[](#%5F%5Fcodelineno-9-29)
[](#%5F%5Fcodelineno-9-30)const addMessageListener = async () => {
[](#%5F%5Fcodelineno-9-31) await Nodejs.addListener('message', event => {
[](#%5F%5Fcodelineno-9-32) console.log('Received message:', event.eventName, event.args);
[](#%5F%5Fcodelineno-9-33) });
[](#%5F%5Fcodelineno-9-34)};
``
To use npm packages, run `npm install --omit=dev` inside the Node.js project directory before building your web project. It's recommended to bundle the Node.js project into a single file (e.g. with [esbuild](https://esbuild.github.io/)) to improve the startup time.
## API[¶](#api "Permanent link")
* [isReady()](#isready)
* [send(...)](#send)
* [start(...)](#start)
* [addListener('message', ...)](#addlistenermessage-)
* [addListener('ready', ...)](#addlistenerready-)
* [removeAllListeners()](#removealllisteners)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
### isReady()[¶](#isready "Permanent link")
`[](#%5F%5Fcodelineno-10-1)isReady() => Promise
`
Check if the Node.js runtime is ready to receive messages.
The Node.js runtime is considered ready as soon as the Node.js project has required the `bridge` module.
Only available on Android and iOS.
**Returns:** `Promise<[IsReadyResult](#isreadyresult)>`
**Since:** 0.0.1
---
### send(...)[¶](#send "Permanent link")
`[](#%5F%5Fcodelineno-11-1)send(options: SendOptions) => Promise
`
Send a message to the Node.js runtime.
This method is only available when the Node.js runtime is ready. Use the `isReady()` method or the `ready` event to check if the Node.js runtime is ready.
Only available on Android and iOS.
| Param | Type |
| ----------- | --------------------------- |
| **options** | [SendOptions](#sendoptions) |
**Since:** 0.0.1
---
### start(...)[¶](#start "Permanent link")
`[](#%5F%5Fcodelineno-12-1)start(options?: StartOptions | undefined) => Promise
`
Start the Node.js runtime manually.
This method is only available if the `startMode` configuration option is set to `manual`.
**Attention**: The Node.js runtime can only be started once per app launch. Stopping and restarting the Node.js runtime is not supported.
Only available on Android and iOS.
| Param | Type |
| ----------- | ----------------------------- |
| **options** | [StartOptions](#startoptions) |
**Since:** 0.0.1
---
### addListener('message', ...)[¶](#addlistenermessage "Permanent link")
`[](#%5F%5Fcodelineno-13-1)addListener(eventName: 'message', listenerFunc: (event: MessageEvent) => void) => Promise
`
Called when a message is received from the Node.js runtime.
Only available on Android and iOS.
| Param | Type |
| ---------------- | ---------------------------------------------- |
| **eventName** | 'message' |
| **listenerFunc** | (event: [MessageEvent](#messageevent)) => void |
**Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>`
**Since:** 0.0.1
---
### addListener('ready', ...)[¶](#addlistenerready "Permanent link")
`[](#%5F%5Fcodelineno-14-1)addListener(eventName: 'ready', listenerFunc: () => void) => Promise
`
Called when the Node.js runtime is ready to receive messages.
Only available on Android and iOS.
| Param | Type |
| ---------------- | ---------- |
| **eventName** | 'ready' |
| **listenerFunc** | () => void |
**Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>`
**Since:** 0.0.1
---
### removeAllListeners()[¶](#removealllisteners "Permanent link")
`[](#%5F%5Fcodelineno-15-1)removeAllListeners() => Promise
`
Remove all listeners for this plugin.
**Since:** 0.0.1
---
### Interfaces[¶](#interfaces "Permanent link")
#### IsReadyResult[¶](#isreadyresult "Permanent link")
| Prop | Type | Description | Since |
| --------- | ------- | ---------------------------------------------------------------- | ----- |
| **ready** | boolean | Whether or not the Node.js runtime is ready to receive messages. | 0.0.1 |
#### SendOptions[¶](#sendoptions "Permanent link")
| Prop | Type | Description | Since |
| ------------- | -------------- | ----------------------------------------------------- | ----- |
| **args** | MessageArg\[\] | The arguments to send to the Node.js runtime. | 0.0.1 |
| **eventName** | string | The name of the event to send to the Node.js runtime. | 0.0.1 |
#### StartOptions[¶](#startoptions "Permanent link")
| Prop | Type | Description | Default | Since |
| ---------- | ---------------------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------------- | ----- |
| **args** | string\[\] | The arguments to pass to the Node.js process. | | 0.0.1 |
| **env** | { \[key: string\]: string; } | The environment variables to set for the Node.js process. | | 0.0.1 |
| **script** | string | The path of the script file to run, relative to the Node.js project directory. | The main field of the package.json file of the Node.js project. | 0.0.1 |
#### PluginListenerHandle[¶](#pluginlistenerhandle "Permanent link")
| Prop | Type |
| ---------- | ------------------- |
| **remove** | () => Promise |
#### MessageEvent[¶](#messageevent "Permanent link")
| Prop | Type | Description | Since |
| ------------- | -------------- | -------------------------------------------------------- | ----- |
| **args** | MessageArg\[\] | The arguments received from the Node.js runtime. | 0.0.1 |
| **eventName** | string | The name of the event received from the Node.js runtime. | 0.0.1 |
### Type Aliases[¶](#type-aliases "Permanent link")
#### MessageArg[¶](#messagearg "Permanent link")
A single argument of a message that is exchanged with the Node.js runtime.
The value must be JSON-serializable.
`string | number | boolean | null | MessageArg[] | { [key: string]: [MessageArg](#messagearg) }`
## Limitations[¶](#limitations "Permanent link")
The underlying [Node.js for Mobile Apps](https://github.com/nodejs-mobile/nodejs-mobile) runtime has some limitations that you should be aware of:
* **Single instance**: The Node.js runtime can only be started once per app launch. Stopping and restarting the runtime is not supported.
* **No child processes**: The `child_process` module is not supported on mobile platforms.
* **No JIT on iOS**: On iOS, the JavaScript engine runs in interpreter-only mode (no JIT compilation), which results in slower JavaScript execution compared to Android.
* **App size**: Embedding the Node.js runtime increases the app size by several tens of megabytes per CPU architecture.
* **Native addons**: Node.js native addons are only supported on Android if they are provided as prebuilds (see [node-gyp-build](https://github.com/prebuild/node-gyp-build)) for the target architectures.
* **`process.exit()`**: Calling `process.exit()` is not allowed by the Apple App Store guidelines.
## FAQ[¶](#faq "Permanent link")
### Which Node.js version is supported?[¶](#which-nodejs-version-is-supported "Permanent link")
The plugin currently runs Node.js `18.20.4`, the latest version available from [Node.js for Mobile Apps](https://github.com/nodejs-mobile/nodejs-mobile). Support for newer Node.js versions requires self-built runtime binaries for mobile platforms, which we are evaluating.
### Why is there no `stop()` method?[¶](#why-is-there-no-stop-method "Permanent link")
The underlying runtime only supports a single Node.js instance per app launch and provides no API to stop or restart it. A `stop()` method would therefore leave the app in a state where Node.js could never be started again until the app is restarted. If you need to stop work in the Node.js runtime, send a message (e.g. a `shutdown` event) and let your Node.js code stop its servers and timers. The idle runtime consumes negligible resources.
## Changelog[¶](#changelog "Permanent link")
See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/nodejs/CHANGELOG.md).
## License[¶](#license "Permanent link")
See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/nodejs/LICENSE).
---
1. This project is not affiliated with, endorsed by, sponsored by, or approved by the OpenJS Foundation or any of their affiliates or subsidiaries. [↩](#fnref:1 "Jump back to footnote 1 in the text")
2. `Node.js` is a registered trademark of the OpenJS Foundation. [↩](#fnref:2 "Jump back to footnote 2 in the text")
July 5, 2026
Back to top
```json
{"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/nodejs/#article", "headline": "Capacitor Node.js Plugin for Android & iOS", "name": "Capacitor Node.js Plugin for Android & iOS", "description": "Run a full Node.js runtime in your Capacitor app on Android and iOS. Use npm packages and exchange messages with the Node.js engine.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/nodejs/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/nodejs/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/nodejs/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/nodejs/#software", "name": "Capacitor Node.js Plugin for Android & iOS", "description": "Run a full Node.js runtime in your Capacitor app on Android and iOS. Use npm packages and exchange messages with the Node.js engine.", "url": "https://capawesome.io/docs/sdks/capacitor/nodejs/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]}
```