### Start Example App Packager

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/CONTRIBUTING.md

Starts the Metro server for the example application. This is necessary to run the example app.

```sh
yarn example start
```

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

### Run Example App on iOS

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/CONTRIBUTING.md

Builds and runs the example application on an iOS simulator or device.

```sh
yarn example ios
```

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

### Run Example App on Android

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/CONTRIBUTING.md

Builds and runs the example application on an Android device or emulator.

```sh
yarn example android
```

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

### Install react-native-in-app-updates

Source: https://context7.com/aravind3566/react-native-in-app-updates/llms.txt

Use npm or yarn to install the library. Remember to rebuild the native app after installation.

```sh
npm install react-native-in-app-updates
# or
yarn add react-native-in-app-updates
```

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

### Install Project Dependencies

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/CONTRIBUTING.md

Run this command in the root directory to install all project dependencies using Yarn workspaces.

```sh
yarn
```

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

### Start Metro Server (npm/Yarn)

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/example/README.md

Initiates the Metro JavaScript bundler, essential for React Native development. Run this command from the root of your project.

```bash
# using npm
npm start

# OR using Yarn
yarn start
```

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

### Install react-native-in-app-updates

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/README.md

Install the package using npm.

```sh
npm install react-native-in-app-updates
```

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

### Check for Updates and Trigger Flows

Source: https://context7.com/aravind3566/react-native-in-app-updates/llms.txt

This example demonstrates how to check for available updates and trigger either a flexible or immediate update flow. It includes error handling for various scenarios, such as non-Android platforms or invalid update flows. The flexible update downloads silently, while the immediate update requires user interaction.

```typescript
import { useEffect, useState } from 'react';
import { Platform, Text, View, Button } from 'react-native';
import { checkForUpdate, UpdateFlow } from 'react-native-in-app-updates';

export default function App() {
  const [status, setStatus] = useState<string>('Idle');

  // Trigger a flexible update check on mount
  useEffect(() => {
    if (Platform.OS !== 'android') {
      setStatus('In-app updates are Android-only');
      return;
    }
    triggerFlexibleUpdate();
  }, []);

  async function triggerFlexibleUpdate() {
    try {
      // Resolves with "Flexible update started" or "No update available"
      const result = await checkForUpdate(UpdateFlow.FLEXIBLE);
      setStatus(result);
    } catch (e: any) {
      // e.message contains one of:
      //   "This library is only available on Android."
      //   "Invalid update flow. Use UpdateFlow.IMMEDIATE or UpdateFlow.FLEXIBLE."
      //   "NO_ACTIVITY" / "UPDATE_CHECK_FAILED" from the native side
      setStatus(`Error: ${e.message}`);
    }
  }

  async function triggerImmediateUpdate() {
    try {
      // Blocks until the user completes or cancels the update
      const result = await checkForUpdate(UpdateFlow.IMMEDIATE);
      // result === "Update flow finished"
      setStatus(result);
    } catch (e: any) {
      // e.message === "UPDATE_CANCELLED" if the user dismissed the dialog
      // e.message === "NOT_ALLOWED" if the Play Store disallows immediate updates
      setStatus(`Error: ${e.message}`);
    }
  }

  return (
    <View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
      <Text>Status: {status}</Text>
      <Button title="Flexible Update" onPress={triggerFlexibleUpdate} />
      <Button title="Immediate Update" onPress={triggerImmediateUpdate} />
    </View>
  );
}
```

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

### Start iOS Application (npm/Yarn)

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/example/README.md

Launches your React Native application on an iOS simulator or device. Ensure the Metro server is running in a separate terminal.

```bash
# using npm
npm run ios

# OR using Yarn
yarn ios
```

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

### Perform Immediate In-App Update

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/README.md

Initiates an immediate update flow, requiring users to install the update before they can continue using the app.

```javascript
await checkForUpdate(UpdateFlow.IMMEDIATE);
```

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

### Start Android Application (npm/Yarn)

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/example/README.md

Launches your React Native application on an Android emulator or device. Ensure the Metro server is running in a separate terminal.

```bash
# using npm
npm run android

# OR using Yarn
yarn android
```

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

### Publish New Versions

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/CONTRIBUTING.md

Uses release-it to handle version bumping, tagging, and creating releases on npm. Run this command to publish new versions of the library.

```sh
yarn release
```

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

### Lint Project Files

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/CONTRIBUTING.md

Runs ESLint to check for code style and potential errors. Use the --fix flag to automatically correct formatting issues.

```sh
yarn lint
```

```sh
yarn lint --fix
```

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

### Run Unit Tests

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/CONTRIBUTING.md

Executes the unit tests for the project using Jest.

```sh
yarn test
```

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

### Perform Flexible In-App Update

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/README.md

Initiates a flexible update flow, allowing users to download updates in the background while continuing to use the app.

```javascript
await checkForUpdate(UpdateFlow.FLEXIBLE);
```

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

### Type Check Project Files

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/CONTRIBUTING.md

Verifies that all TypeScript files in the project adhere to the defined types.

```sh
yarn typecheck
```

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

### Import and use UpdateFlow enum

Source: https://context7.com/aravind3566/react-native-in-app-updates/llms.txt

Import the UpdateFlow enum to specify the desired update strategy. FLEXIBLE allows background downloads, while IMMEDIATE forces a full-screen update.

```typescript
import { UpdateFlow } from 'react-native-in-app-updates';

// UpdateFlow.FLEXIBLE  — background download, non-blocking
// UpdateFlow.IMMEDIATE — full-screen blocking update prompt
console.log(UpdateFlow.FLEXIBLE);   // "FLEXIBLE"
console.log(UpdateFlow.IMMEDIATE);  // "IMMEDIATE"
```

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

### checkForUpdate Function

Source: https://context7.com/aravind3566/react-native-in-app-updates/llms.txt

Queries the Google Play Store for an available update and, if one exists, launches the specified update flow. Returns a promise that resolves with a status string or rejects with an error. On non-Android platforms the promise is immediately rejected. If `updateFlow` is not a valid `UpdateFlow` enum value, the promise is also rejected.

```APIDOC
## checkForUpdate(updateFlow: UpdateFlow): Promise<string>

### Description
Queries the Google Play Store for an available update and, if one exists, launches the specified update flow. Returns a promise that resolves with a status string or rejects with an error. On non-Android platforms the promise is immediately rejected. If `updateFlow` is not a valid `UpdateFlow` enum value, the promise is also rejected.

**Flexible flow** — the update downloads silently in the background. The native module registers an install-state listener and calls `completeUpdate()` automatically when the download finishes.

**Immediate flow** — presents a full-screen system UI that the user must interact with. The promise resolves with `"Update flow finished"` when the user completes the flow, or rejects with `"UPDATE_CANCELLED"` if they dismiss it.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **updateFlow** (UpdateFlow) - Required - Specifies the type of update flow to initiate. Must be either `UpdateFlow.FLEXIBLE` or `UpdateFlow.IMMEDIATE`.

### Request Example
```typescript
import { checkForUpdate, UpdateFlow } from 'react-native-in-app-updates';

// For a flexible update
async function triggerFlexibleUpdate() {
  try {
    const result = await checkForUpdate(UpdateFlow.FLEXIBLE);
    console.log(result); // e.g., "Flexible update started" or "No update available"
  } catch (e: any) {
    console.error(e.message);
  }
}

// For an immediate update
async function triggerImmediateUpdate() {
  try {
    const result = await checkForUpdate(UpdateFlow.IMMEDIATE);
    console.log(result); // "Update flow finished"
  } catch (e: any) {
    console.error(e.message); // e.g., "UPDATE_CANCELLED"
  }
}
```

### Response
#### Success Response
- **string**: A status message indicating the outcome of the update check and flow initiation.
  - `
```

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

### UpdateFlow Enum

Source: https://context7.com/aravind3566/react-native-in-app-updates/llms.txt

The UpdateFlow enum defines the two supported strategies for in-app updates on Android: FLEXIBLE and IMMEDIATE. FLEXIBLE allows background downloads without blocking the user, while IMMEDIATE prompts a full-screen, blocking update.

```APIDOC
## UpdateFlow Enum

Represents the two supported Android in-app update strategies. Pass one of these values to `checkForUpdate`.

```typescript
import { UpdateFlow } from 'react-native-in-app-updates';

// UpdateFlow.FLEXIBLE  — background download, non-blocking
// UpdateFlow.IMMEDIATE — full-screen blocking update prompt
console.log(UpdateFlow.FLEXIBLE);   // "FLEXIBLE"
console.log(UpdateFlow.IMMEDIATE);  // "IMMEDIATE"
```
```

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

### UpdateFlow Enum and checkForUpdate Signature

Source: https://context7.com/aravind3566/react-native-in-app-updates/llms.txt

Defines the available update flows (IMMEDIATE, FLEXIBLE) and the signature for the `checkForUpdate` function. This provides the type information for integrating in-app updates.

```typescript
export declare enum UpdateFlow {
  IMMEDIATE = "IMMEDIATE",
  FLEXIBLE  = "FLEXIBLE",
}

export declare function checkForUpdate(updateFlow: UpdateFlow): Promise<string>;
```

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

### Check for Updates in React Native

Source: https://github.com/aravind3566/react-native-in-app-updates/blob/main/README.md

Use this code within a useEffect hook to check for available updates. It handles potential errors during the update check.

```javascript
import { useEffect } from 'react';
import { checkForUpdate, UpdateFlow } from 'react-native-in-app-updates';

useEffect(() => {
  getData();
}, []);

async function getData() {
  try {
    await checkForUpdate(UpdateFlow.FLEXIBLE);
  } catch (e) {
    // Handle error
  }
}
```

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

### UpdateFlow Enum

Source: https://context7.com/aravind3566/react-native-in-app-updates/llms.txt

Enum defining the available update flows for `checkForUpdate`.

```APIDOC
## UpdateFlow Enum

### Description
Defines the types of in-app update flows that can be initiated.

### Members
- **IMMEDIATE**: Initiates a full-screen update flow that requires user interaction.
- **FLEXIBLE**: Initiates a silent background download for the update.
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.