capacitor-persistent-account

KO | EN

gitlite — search

#hacktoberfest #react #ai #go #golang #android #linux #windows #cli #kubernetes #security #pytorch #ios #mcp

capacitor-persistent-account

(★ 11)

Capacitor plugin to persist account data between app install

capacitor-persistent-account Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# @capgo/capacitor-persistent-account

This plugin allows you to securely store account information for a user in Capacitor, and keep it between reinstall

## Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/persistent-account/

## Compatibility

| Plugin version | Capacitor compatibility | Maintained |
| -------------- | ----------------------- | ---------- |
| v8.\*.\*       | v8.\*.\*                | ✅          |
| v7.\*.\*       | v7.\*.\*                | On demand   |
| v6.\*.\*       | v6.\*.\*                | ❌          |
| v5.\*.\*       | v5.\*.\*                | ❌          |

> **Note:** The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

## Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

```bash
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins
```

Then use the following prompt:

```text
Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-persistent-account` plugin in my project.
```

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

```bash
npm install @capgo/capacitor-persistent-account
npx cap sync
```

## API

<docgen-index>

* [`readAccount()`](#readaccount)
* [`saveAccount(...)`](#saveaccount)
* [`getPluginVersion()`](#getpluginversion)

</docgen-index>

<docgen-api>

Capacitor Persistent Account Plugin

Provides persistent storage for account data across app sessions using platform-specific
secure storage mechanisms. On iOS, this uses the Keychain. On Android, this uses
AccountManager. This ensures account data persists even after app reinstallation.

### readAccount()

```typescript
readAccount() => Promise<{ data: unknown | null; }>
```

Reads the stored account data from persistent storage.

Retrieves account data that was previously saved using saveAccount(). The data
persists across app sessions and survives app reinstallation on supported platforms.

**Returns:** <code>Promise&lt;{ data: unknown; }&gt;</code>

--------------------

### saveAccount(...)

```typescript
saveAccount(options: { data: unknown; }) => Promise<void>
```

Saves account data to persistent storage.

Stores the provided account data using platform-specific secure storage mechanisms.
The data will persist across app sessions and survive app reinstallation.
Any existing account data will be overwritten.

| Param         | Type                            | Description                                       |
| ------------- | ------------------------------- | ------------------------------------------------- |
| **`options`** | <code>{ data: unknown; }</code> | - The options object containing the data to save. |

--------------------

### getPluginVersion()

```typescript
getPluginVersion() => Promise<{ version: string; }>
```

Get the native Capacitor plugin version

Returns the version string of the native plugin implementation. Useful for
debugging and ensuring compatibility between the JavaScript and native layers.

**Returns:** <code>Promise&lt;{ version: string; }&gt;</code>

--------------------

</docgen-api>

capacitor-persistent-account

capacitor-persistent-account Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

capacitor-persistent-account

capacitor-persistent-account Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README