{"_id":"@capgo/capacitor-firebase-functions","_rev":"4-94a04e3a2157154bfb10bc183cd80544","name":"@capgo/capacitor-firebase-functions","dist-tags":{"latest":"7.4.2"},"versions":{"7.4.0":{"name":"@capgo/capacitor-firebase-functions","version":"7.4.0","keywords":["capacitor","plugin","native"],"author":{"name":"Capgo Team"},"license":"Apache-2.0","_id":"@capgo/capacitor-firebase-functions@7.4.0","maintainers":[{"name":"riderx","email":"martin.donadieu@hey.com"}],"homepage":"https://capgo.app/","bugs":{"url":"https://github.com/Cap-go/capacitor-firebase/issues"},"dist":{"shasum":"d7c91e624402d2d190eecd11d405a78ccf039df7","tarball":"https://registry.npmjs.org/@capgo/capacitor-firebase-functions/-/capacitor-firebase-functions-7.4.0.tgz","fileCount":39,"integrity":"sha512-1k+gffOqvh1HGrrtX0JxfxfhMiCKX6hlSBMWyK0oB1biCfBZ6POroGc6qq7XewIAzLjWo5MVCPM7spsIOT5RAw==","signatures":[{"sig":"MEUCIQDY9b5CWx15H5B89sJFyORHtPMcHPnVllYGBReYSyyr4AIgcS7Q8O2gIj5cmKrtHIK6FyxixjpT7DgMG353NVle68M=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":58920},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"97786da96a720a520f80ac1031a0f12063f135d7","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api FirebaseFunctionsPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","verify:ios":"xcodebuild -scheme CapgoCapacitorFirebaseFunctions -destination generic/platform=iOS","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"riderx","email":"martin.donadieu@hey.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/Cap-go/capacitor-firebase.git","type":"git"},"_npmVersion":"11.6.2","description":"Capacitor plugin for Firebase Cloud Functions.","directories":{},"_nodeVersion":"24.11.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.0.1","rollup":"4.30.1","firebase":"12.6.0","prettier":"3.4.2","swiftlint":"2.0.0","typescript":"4.1.5","@capacitor/cli":"7.0.0","@capacitor/ios":"7.0.0","@capacitor/core":"7.0.0","@capacitor/docgen":"0.3.0","@capacitor/android":"7.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"2.0.0"},"peerDependencies":{"firebase":"12.6.0","@capacitor/core":">=7.0.0"},"peerDependenciesMeta":{"firebase":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/capacitor-firebase-functions_7.4.0_1763998905229_0.48663251632476223","host":"s3://npm-registry-packages-npm-production"}},"7.4.1":{"name":"@capgo/capacitor-firebase-functions","version":"7.4.1","keywords":["capacitor","plugin","native"],"author":{"name":"Capgo Team"},"license":"Apache-2.0","_id":"@capgo/capacitor-firebase-functions@7.4.1","maintainers":[{"name":"riderx","email":"martin.donadieu@hey.com"}],"homepage":"https://capgo.app/","bugs":{"url":"https://github.com/Cap-go/capacitor-firebase/issues"},"dist":{"shasum":"9e24f2d999c6786b818eeb84b10a2237d6076632","tarball":"https://registry.npmjs.org/@capgo/capacitor-firebase-functions/-/capacitor-firebase-functions-7.4.1.tgz","fileCount":39,"integrity":"sha512-EEnXVEjCMexy198gBehPsyqxGBJxRrmkmDtAc7cJ1iEYmoW+2jZJESuAWSUR+KNy0G+yt3E49FdMijZzbsCUSg==","signatures":[{"sig":"MEYCIQC66imZCMedHdtY6hEPkS8o3UO0D8UyySyaJ9g7FnyBCQIhALpXJ6Ud12qdQGZhS3k0Ty09LcUTxaejQ18TpimH/7A9","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":58680},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"c965f5a7def32792245434af874be9775557c34d","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api FirebaseFunctionsPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","verify:ios":"xcodebuild -scheme CapgoCapacitorFirebaseFunctions -destination generic/platform=iOS","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"riderx","email":"martin.donadieu@hey.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/Cap-go/capacitor-firebase.git","type":"git"},"_npmVersion":"11.6.2","description":"Capacitor plugin for Firebase Cloud Functions.","directories":{},"_nodeVersion":"24.11.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.0.1","rollup":"4.30.1","firebase":"12.6.0","prettier":"3.4.2","swiftlint":"2.0.0","typescript":"4.1.5","@capacitor/cli":"7.0.0","@capacitor/ios":"7.0.0","@capacitor/core":"7.0.0","@capacitor/docgen":"0.3.0","@capacitor/android":"7.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"2.0.0"},"peerDependencies":{"firebase":"12.6.0","@capacitor/core":">=7.0.0"},"peerDependenciesMeta":{"firebase":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/capacitor-firebase-functions_7.4.1_1763999731441_0.9234706869285407","host":"s3://npm-registry-packages-npm-production"}},"7.4.2":{"name":"@capgo/capacitor-firebase-functions","version":"7.4.2","keywords":["capacitor","plugin","native"],"author":{"name":"Capgo Team"},"license":"MPL-2.0","_id":"@capgo/capacitor-firebase-functions@7.4.2","maintainers":[{"name":"riderx","email":"martin.donadieu@hey.com"}],"homepage":"https://capgo.app/","bugs":{"url":"https://github.com/Cap-go/capacitor-firebase/issues"},"dist":{"shasum":"3c64ea4b4836919c09d065c663e3adc8f8626fbf","tarball":"https://registry.npmjs.org/@capgo/capacitor-firebase-functions/-/capacitor-firebase-functions-7.4.2.tgz","fileCount":40,"integrity":"sha512-ZpXsEUs9nkfbPtYfIfqD2eEhPStyNY8zUQAZUGEhcg0C0tUU2LoOaWeegP39LeTTI1ymq0xMCbnAnnFPM01JCg==","signatures":[{"sig":"MEUCIQDXUje+ozmAwB6OUcg5NjIEMJcQflZZ8ePjWcgkXcxT6AIgANjoaFNOMjTBfwiJCzqP60GKRoYoUq75lPWX2++9eiU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":75402},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"8d8a06c3dfefe13eb43aaf4313ef701ee9a76767","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api FirebaseFunctionsPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","verify:ios":"xcodebuild -scheme CapgoCapacitorFirebaseFunctions -destination generic/platform=iOS","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"riderx","email":"martin.donadieu@hey.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/Cap-go/capacitor-firebase.git","type":"git"},"_npmVersion":"11.6.2","description":"Capacitor plugin for Firebase Cloud Functions.","directories":{},"_nodeVersion":"24.11.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.0.1","rollup":"4.30.1","firebase":"12.6.0","prettier":"3.4.2","swiftlint":"2.0.0","typescript":"4.1.5","@capacitor/cli":"7.0.0","@capacitor/ios":"7.0.0","@capacitor/core":"7.0.0","@capacitor/docgen":"0.3.0","@capacitor/android":"7.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"2.0.0"},"peerDependencies":{"firebase":"12.6.0","@capacitor/core":">=7.0.0"},"peerDependenciesMeta":{"firebase":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/capacitor-firebase-functions_7.4.2_1764858703865_0.7163126562529525","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-11-24T15:41:45.082Z","modified":"2026-08-19T10:40:44.102Z","7.4.0":"2025-11-24T15:41:45.411Z","7.4.1":"2025-11-24T15:55:31.628Z","7.4.2":"2025-12-04T14:31:44.029Z"},"bugs":{"url":"https://github.com/Cap-go/capacitor-firebase/issues"},"author":{"name":"Capgo Team"},"license":"MPL-2.0","homepage":"https://capgo.app/","keywords":["capacitor","plugin","native"],"repository":{"url":"git+https://github.com/Cap-go/capacitor-firebase.git","type":"git"},"description":"Capacitor plugin for Firebase Cloud Functions.","maintainers":[{"email":"martin.donadieu@hey.com","name":"riderx"},{"email":"tori@capgo.app","name":"torichancapgo"}],"readme":"# @capacitor-firebase/functions\n\nUnofficial Capacitor plugin for [Firebase Cloud Functions](https://firebase.google.com/docs/functions/).[^1]\n\n<div class=\"capawesome-z29o10a\">\n  <a href=\"https://cloud.capawesome.io/\" target=\"_blank\">\n    <img alt=\"Deliver Live Updates to your Capacitor app with Capawesome Cloud\" src=\"https://cloud.capawesome.io/assets/banners/cloud-deploy-real-time-app-updates.png?t=1\" />\n  </a>\n</div>\n\n## Installation\n\n```bash\nnpm install @capacitor-firebase/functions\nnpx cap sync\n```\n\nAdd Firebase to your project if you haven't already ([Android](https://firebase.google.com/docs/android/setup) / [iOS](https://firebase.google.com/docs/ios/setup)).\n\n### Android\n\n#### Variables\n\nIf needed, you can define the following project variable in your app’s `variables.gradle` file to change the default version of the dependency:\n\n- `$firebaseFunctionsVersion` version of `com.google.firebase:firebase-functions` (default: `21.1.0`)\n\nThis can be useful if you encounter dependency conflicts with other plugins in your project.\n\n## Configuration\n\nNo configuration required for this plugin.\n\n## Demo\n\nA working example can be found here: [robingenz/capacitor-firebase-plugin-demo](https://github.com/robingenz/capacitor-firebase-plugin-demo)\n\n## Usage\n\n```typescript\nimport { FirebaseFunctions } from '@capacitor-firebase/functions';\n\nconst callByName = async () => {\n    const { data } = await FirebaseFunctions.callByName({\n        name: 'helloWorld',\n        data: {\n            string: 'Hello World!',\n            number: 123,\n            boolean: true,\n            array: [1, 2, 3],\n            object: {\n                key: 'value'\n            }\n        }\n    });\n    return data;\n};\n\nconst callByUrl = async () => {\n    const { data } = await FirebaseFunctions.callByUrl({\n        url: 'https://us-central1-YOUR_PROJECT_ID.cloudfunctions.net/helloWorld',\n        data: {\n            string: 'Hello World!',\n            number: 123,\n            boolean: true,\n            array: [1, 2, 3],\n            object: {\n                key: 'value'\n            }\n        }\n    });\n    return data;\n};\n\nconst useEmulator = async () => {\n  await FirebaseFunctions.useEmulator({\n    host: '10.0.2.2',\n    port: 9001,\n  });\n};\n```\n\n## API\n\n<docgen-index>\n\n* [`callByName(...)`](#callbyname)\n* [`callByUrl(...)`](#callbyurl)\n* [`useEmulator(...)`](#useemulator)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### callByName(...)\n\n```typescript\ncallByName<RequestData = unknown, ResponseData = unknown>(options: CallByNameOptions<RequestData>) => Promise<CallByNameResult<ResponseData>>\n```\n\nCall a callable function by name.\n\n| Param         | Type                                                                               |\n| ------------- | ---------------------------------------------------------------------------------- |\n| **`options`** | <code><a href=\"#callbynameoptions\">CallByNameOptions</a>&lt;RequestData&gt;</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#callbynameresult\">CallByNameResult</a>&lt;ResponseData&gt;&gt;</code>\n\n**Since:** 6.1.0\n\n--------------------\n\n\n### callByUrl(...)\n\n```typescript\ncallByUrl<RequestData = unknown, ResponseData = unknown>(options: CallByUrlOptions<RequestData>) => Promise<CallByUrlResult<ResponseData>>\n```\n\nCall a callable function by URL.\n\n| Param         | Type                                                                             |\n| ------------- | -------------------------------------------------------------------------------- |\n| **`options`** | <code><a href=\"#callbyurloptions\">CallByUrlOptions</a>&lt;RequestData&gt;</code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#callbyurlresult\">CallByUrlResult</a>&lt;ResponseData&gt;&gt;</code>\n\n**Since:** 6.1.0\n\n--------------------\n\n\n### useEmulator(...)\n\n```typescript\nuseEmulator(options: UseEmulatorOptions) => Promise<void>\n```\n\nInstrument your app to talk to the Cloud Functions emulator.\n\nOn Android, the cleartext traffic must be allowed. On the Capacitor configuration:\n```\n{\n  server: {\n    cleartext: true\n  }\n}\n```\n**The cleartext traffic is not intended for use in production.**\n\n| Param         | Type                                                              |\n| ------------- | ----------------------------------------------------------------- |\n| **`options`** | <code><a href=\"#useemulatoroptions\">UseEmulatorOptions</a></code> |\n\n**Since:** 6.1.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### CallResult\n\n| Prop       | Type                      | Description                          | Since |\n| ---------- | ------------------------- | ------------------------------------ | ----- |\n| **`data`** | <code>ResponseData</code> | The result of the callable function. | 6.1.0 |\n\n\n#### CallByNameOptions\n\n| Prop         | Type                | Description                          | Since |\n| ------------ | ------------------- | ------------------------------------ | ----- |\n| **`name`**   | <code>string</code> | The name of the callable function.   | 6.1.0 |\n| **`region`** | <code>string</code> | The region of the callable function. | 6.1.0 |\n\n\n#### CallByUrlOptions\n\n| Prop      | Type                | Description                       | Since |\n| --------- | ------------------- | --------------------------------- | ----- |\n| **`url`** | <code>string</code> | The URL of the callable function. | 6.1.0 |\n\n\n#### UseEmulatorOptions\n\n| Prop                       | Type                | Description                                                                                                                                                                     | Default           | Since |\n| -------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ----- |\n| **`host`**                 | <code>string</code> | The emulator host without any port or scheme. Note when using a Android Emulator device: 10.0.2.2 is the special IP address to connect to the 'localhost' of the host computer. |                   | 6.1.0 |\n| **`port`**                 | <code>number</code> | The emulator port.                                                                                                                                                              | <code>5001</code> | 6.1.0 |\n| **`regionOrCustomDomain`** | <code>string</code> | The region the callable functions are located in or a custom domain hosting the callable functions.                                                                             |                   |       |\n\n\n### Type Aliases\n\n\n#### CallByNameResult\n\n<code><a href=\"#callresult\">CallResult</a>&lt;ResponseData&gt;</code>\n\n\n#### CallByUrlResult\n\n<code><a href=\"#callresult\">CallResult</a>&lt;ResponseData&gt;</code>\n\n</docgen-api>\n\n## Changelog\n\nSee [CHANGELOG.md](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/functions/CHANGELOG.md).\n\n## License\n\nSee [LICENSE](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/functions/LICENSE).\n\n[^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries.\n","readmeFilename":"README.md"}