Health Capacitor plugin

Using @capgo/capacitor-health

Capacitor plugin to interact with data from Apple HealthKit and Health Connect.

Install

bun add @capgo/capacitor-health
bunx cap sync

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

import { Health } from '@capgo/capacitor-health';

API at a glance

Examples

isAvailable()

Returns whether the current platform supports the native health SDK.

import { Health } from '@capgo/capacitor-health';

const result = await Health.isAvailable();
console.log(result);

requestAuthorization()

Requests read/write access to the provided data types.

import { Health } from '@capgo/capacitor-health';

const result = await Health.requestAuthorization({ read: ['steps'] });
console.log(result);

checkAuthorization()

Checks authorization status for the provided data types without prompting the user.

import { Health } from '@capgo/capacitor-health';

const result = await Health.checkAuthorization({ read: ['steps'] });
console.log(result);

readSamples()

Reads samples for the given data type within the specified time frame.

import { Health } from '@capgo/capacitor-health';

const result = await Health.readSamples({ dataType: 'steps' });
console.log(result);

saveSample()

Writes a single sample to the native health store.

import { Health } from '@capgo/capacitor-health';

await Health.saveSample({
  dataType: 'steps',
  value: 1,
});

openHealthConnectSettings()

Opens the Health Connect settings screen (Android only). On iOS, this method does nothing.

import { Health } from '@capgo/capacitor-health';

await Health.openHealthConnectSettings();

The table above lists the 9 core methods. Listener and version helpers, and the full contract of each method, are documented in the GitHub repository.

Full reference

• GitHub repository
• Documentation
• API reference

Keep going from Using @capgo/capacitor-health

If you are using Using @capgo/capacitor-health to plan native plugin work, connect it with @capgo/capacitor-health for the implementation detail in @capgo/capacitor-health, Getting Started for the implementation detail in Getting Started, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins.