### Setup Project Dependencies

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/logger-1.7.0/README.md

Run bin/setup to install project dependencies after cloning the repository.

```bash
$ bin/setup
```

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

### Setup Development Environment

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/atomos-0.1.3/README.md

Run this command after cloning the repository to install necessary development dependencies.

```bash
bin/setup
```

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

### Basic Request Setup with Ethon

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/ethon-0.15.0/README.md

Initialize an Ethon::Easy object with a URL and perform a request. This is the most basic way to start using the gem.

```ruby
easy = Ethon::Easy.new(url: "www.example.com")
easy.perform
#=> :ok
```

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

### Install @dariyd/react-native-document-scanner

Source: https://context7.com/dariyd/react-native-document-scanner/llms.txt

Use npm or yarn to install the library. Remember to run `pod install` for iOS after installation.

```bash
# npm
npm install @dariyd/react-native-document-scanner

# yarn
yarn add @dariyd/react-native-document-scanner

# iOS — run pod install after npm install
cd ios && pod install
```

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

### Install iOS Pods

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/README.md

After installing the library, navigate to the 'ios' directory and run 'pod install' to link the native dependencies.

```bash
cd ios && pod install
```

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

### Setup TestChat Server Dependencies

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/ios/Pods/SocketRocket/README.md

Install necessary Python packages for the TestChat server using pip within a virtual environment. Ensure 'make test' has been run previously to set up the virtual environment.

```bash
source .env/bin/activate
pip install git+https://github.com/tornadoweb/tornado.git
```

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

### Install Benchmark Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/benchmark-0.4.1/README.md

Add the benchmark gem to your Gemfile and run bundle, or install it directly using gem install.

```ruby
gem 'benchmark'
```

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

### Install Cocoapods Try Plugin

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/cocoapods-try-1.2.0/README.md

Install the cocoapods-try plugin using the gem command.

```bash
$ gem install cocoapods-try
```

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

### Install Ruby-FFI with System libffi

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/ffi-1.17.2/README.md

Use these commands to install the FFI gem while enforcing the use of the system's libffi library. This can speed up installation.

```bash
gem install ffi -- --enable-system-libffi
```

```bash
bundle config build.ffi --enable-system-libffi
```

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

### Unit Tests with Minitest::Test

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/minitest-5.26.0/README.rdoc

Define unit tests using methods starting with 'test_'. Use 'setup' for common test initialization. Assertions like 'assert_equal' and 'refute_match' are available. Tests can be skipped using 'skip'.

```ruby
require "minitest/autorun"

class TestMeme < Minitest::Test
  def setup
    @meme = Meme.new
  end

  def test_that_kitty_can_eat
    assert_equal "OHAI!", @meme.i_can_has_cheezburger?
  end

  def test_that_it_will_not_blend
    refute_match /^no/i, @meme.will_it_blend?
  end

  def test_that_will_be_skipped
    skip "test this later"
  end
end
```

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

### Full Document Scanner Component Example

Source: https://context7.com/dariyd/react-native-document-scanner/llms.txt

This component demonstrates how to use the `launchScanner` function to capture documents. It handles scanner results, including cancellation and errors, and displays the scanned images. Ensure the necessary permissions and setup are done before using this component.

```tsx
import React, { useState } from 'react';
import {
  Alert, Button, Image, SafeAreaView,
  ScrollView, StyleSheet, Text, View,
} from 'react-native';
import { launchScanner, ImageObject } from '@dariyd/react-native-document-scanner';

export default function DocumentScannerScreen() {
  const [pages, setPages] = useState<ImageObject[]>([]);
  const [status, setStatus] = useState('');

  const scan = async () => {
    try {
      setStatus('Opening scanner…');
      const result = await launchScanner({
        quality: 0.8,
        includeExif: true,
        includeLocationExif: true,
      });

      if (result.didCancel) {
        setStatus('Cancelled');
      } else if (result.error) {
        setStatus(`Error: ${result.errorMessage}`);
        Alert.alert('Scanner Error', result.errorMessage);
      } else {
        setPages(result.images ?? []);
        setStatus(`Scanned ${result.images?.length} page(s)`);
      }
    } catch (err: any) {
      setStatus(`Exception: ${err.message}`);
    }
  };

  return (
    <SafeAreaView style={styles.container}>
      <Button title="Scan Document" onPress={scan} />
      <Text style={styles.status}>{status}</Text>
      <ScrollView horizontal>
        {pages.map((img, i) => (
          <View key={img.fileName} style={styles.card}>
            <Image source={{ uri: img.uri }} style={styles.thumb} />
            <Text>Page {i + 1} — {Math.round(img.fileSize / 1024)} KB</Text>
            {img.exif?.GPSLatitude !== undefined && (
              <Text>📍 {img.exif.GPSLatitude.toFixed(4)}, {img.exif.GPSLongitude.toFixed(4)}</Text>
            )}
          </View>
        ))}
      </ScrollView>
    </SafeAreaView>
  );
}

const styles = StyleSheet.create({
  container: { flex: 1, padding: 16 },
  status:    { marginVertical: 12, color: '#555' },
  card:      { marginRight: 12, alignItems: 'center', width: 120 },
  thumb:     { width: 120, height: 160, borderRadius: 8, backgroundColor: '#ddd' },
});

```

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

### Install Dependencies and Run Tests

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/netrc-0.11.0/Readme.md

Installs the necessary gems using Bundler and then executes all test files in the test directory.

```bash
$ bundle install
$ bundle exec ruby -e 'Dir.glob "./test ** /test_*.rb", &method(:require)'
```

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

### Install react-native-document-scanner via npm

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/README.md

Use this command to install the library using npm. This is the recommended installation method.

```bash
npm install @dariyd/react-native-document-scanner
```

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

### Install Base64 Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/base64-0.3.0/README.md

Add the base64 gem to your Gemfile and run bundle install, or install it directly using the gem install command.

```ruby
gem 'base64'
```

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

### Install Native IDN Support

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/addressable-2.8.7/README.md

Instructions for installing libidn on Debian/Ubuntu and OS X, followed by the gem installation for native Internationalized Domain Name (IDN) support.

```bash
$ sudo apt-get install libidn11-dev # Debian/Ubuntu
$ brew install libidn # OS X
$ gem install idn-ruby
```

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

### Start a Reaper Thread

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/connection_pool-2.5.4/README.md

Run a background thread to periodically reap idle connections. This example reaps connections idle for 300 seconds every 300 seconds.

```ruby
cp = ConnectionPool.new { Redis.new }

# Start a reaper thread to reap connections that have been idle for 300 seconds (5 minutes).
Thread.new do
  loop do
    cp.reap(300) { |conn| conn.close }
    sleep 300
  end
end
```

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

### Install CocoaPods::Trunk Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/cocoapods-trunk-1.6.0/README.md

Alternatively, install the cocoapods-trunk gem directly using the gem install command.

```bash
$ gem install cocoapods-trunk
```

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

### Install Minitest Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/minitest-5.26.0/README.rdoc

Use this command to install the Minitest gem. This is the recommended method for obtaining the latest features.

```bash
sudo gem install minitest
```

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

### Install Ruby-FFI from Git Repository

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/ffi-1.17.2/README.md

Clone the FFI repository locally and install it using Bundler. This is useful for development or testing.

```bash
git clone git://github.com/ffi/ffi.git
cd ffi
git submodule update --init --recursive
bundle install
rake install
```

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

### Install Bundler Dependencies

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/typhoeus-1.5.0/README.md

Install project dependencies using Bundler.

```bash
bundle install
```

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

### Install react-native-document-scanner from GitHub (yarn)

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/README.md

Install the latest development version directly from GitHub using yarn. This is an alternative to npm for GitHub installations.

```bash
yarn add https://github.com/dariyd/react-native-document-scanner.git
```

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

### Build and Install double-conversion with MacPorts

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/ios/Pods/RCT-Folly/README.md

Download, build, and install the double-conversion library. Ensure to build it as a shared library.

```bash
git clone https://github.com/google/double-conversion.git
  cd double-conversion
  cmake -DBUILD_SHARED_LIBS=ON .
  make
  sudo make install
```

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

### Install Molinillo Gem Directly

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/molinillo-0.8.0/README.md

Use this command to install the Molinillo gem directly if you are not using Bundler or want to install it globally.

```bash
$ gem install molinillo
```

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

### Install Ruby-FFI from GitHub

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/ffi-1.17.2/README.md

Install the FFI gem directly from its GitHub repository using Bundler. Ensure submodules are updated.

```ruby
gem 'ffi', github: 'ffi/ffi', submodules: true
```

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

### Install cocoapods-search Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/cocoapods-search-1.0.1/README.md

Install cocoapods-search as a separate gem if you don't have CocoaPods installed. This command installs the gem and makes it available for use.

```bash
$ gem install cocoapods-search
```

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

### Install Local Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/logger-1.7.0/README.md

Run rake install to install the gem onto your local machine.

```bash
$ rake install
```

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

### Install react-native-document-scanner via yarn

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/README.md

Use this command to install the library using yarn. This is an alternative to npm.

```bash
yarn add @dariyd/react-native-document-scanner
```

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

### Install CFPropertyList Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/CFPropertyList-3.0.7/README.md

Install the CFPropertyList gem using RubyGems. This is the recommended method for adding the gem to your project.

```bash
gem install CFPropertyList
```

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

### Build and Install Folly with MacPorts

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/ios/Pods/RCT-Folly/README.md

Clone the Folly repository, create a build directory, and then configure, build, and install Folly using CMake and make.

```bash
git clone https://github.com/facebook/folly.git
  cd folly
  mkdir _build
  cd _build
  cmake ..
  make
  sudo make install
```

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

### Install Folly with Vcpkg on Windows

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/ios/Pods/RCT-Folly/README.md

Use Vcpkg to install Folly for 64-bit Windows. You can install a release version or build from the main branch.

```bash
vcpkg install folly:x64-windows
```

```bash
vcpkg install folly:x64-windows --head
```

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

### Install ruby-macho Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/ruby-macho-2.5.1/README.md

Install the ruby-macho gem using the standard RubyGems command.

```bash
gem install ruby-macho
```

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

### Install NKF Gem Manually

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/nkf-0.2.0/README.md

Alternatively, install the NKF gem directly using this command.

```bash
$ gem install nkf
```

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

### Install react-native-document-scanner from GitHub

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/README.md

Install the latest development version directly from GitHub using npm. This is useful for testing unreleased features.

```bash
npm install https://github.com/dariyd/react-native-document-scanner.git
```

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

### Install Local Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/atomos-0.1.3/README.md

Install the gem onto your local machine using this Rake command.

```bash
bundle exec rake install
```

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

### Install JSON Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/json-2.15.1/README.md

Install the JSON gem if you are not using bundler for dependency management.

```bash
$ gem install json
```

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

### Install Dependencies with Bundler

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/molinillo-0.8.0/README.md

Execute this command in your terminal after updating your Gemfile to install the specified gems.

```bash
$ bundle install
```

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

### Run Trunk with Local Install

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/cocoapods-trunk-1.6.0/README.md

Execute the pod trunk command with a local install of trunk.cocoapods.org by setting the TRUNK_SCHEME_AND_HOST environment variable.

```bash
$ env TRUNK_SCHEME_AND_HOST=http://localhost:4567 bundle exec pod trunk --help
```

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

### Install Gem Dependencies

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/atomos-0.1.3/README.md

Execute this command in your terminal after updating your Gemfile to install the gem and its dependencies.

```bash
$ bundle
```

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

### Install Active Support with RubyGems

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/activesupport-7.2.2.2/README.rdoc

Use this command to install the latest version of Active Support via RubyGems.

```bash
$ gem install activesupport
```

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

### Install SocketRocket with CocoaPods

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/ios/Pods/SocketRocket/README.md

Add this line to your Podfile to include SocketRocket in your project. Then run 'pod install'.

```ruby
pod 'SocketRocket'
```

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

### Installing the Colored2 Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/colored2-3.1.2/README.md

Provides instructions for adding the Colored2 gem to a Ruby project using Bundler or direct installation.

```ruby
gem 'colored2'
```

```bash
$ bundle
```

```bash
$ gem install colored2
```

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

### Android Location Permission Setup

Source: https://context7.com/dariyd/react-native-document-scanner/llms.txt

On Android, no manual setup is needed as the library automatically merges the required permission declarations into the AndroidManifest.xml.

```xml
<!-- Android: no manual setup needed.
     The library's AndroidManifest.xml already declares:
       <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
       <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
     These are merged automatically by the Gradle build. -->
```

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

### Install cocoapods-downloader Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/cocoapods-downloader-2.1/README.markdown

Install the cocoapods-downloader gem using the RubyGems package manager. Use sudo if necessary.

```bash
$ [sudo] gem install cocoapods-downloader
```

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

### Install Algolia Ruby API Client

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/algoliasearch-1.27.5/README.md

Install the Algolia Ruby API Client using the RubyGems package manager. This command is run in the terminal.

```bash
gem install algoliasearch
```

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

### Element XPath Relative to Ancestor

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/rexml-3.4.4/doc/rexml/tutorial.rdoc

This example demonstrates how to get the XPath string for an element relative to its most distant ancestor.

```ruby
doc.root.xpath             # => "/bookstore"
doc.root.texts.first.xpath # => "/bookstore/text()"
```

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

### Print Hello World to Stdout

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/ios/Pods/fmt/README.md

Basic example of printing a simple string to standard output using fmt::print.

```cpp
#include <fmt/core.h>

int main() {
  fmt::print("Hello, world!\n");
}
```

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

### Start TestChat Server (Go)

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/ios/Pods/SocketRocket/README.md

Compile and run the Go implementation of the chatroom server. Navigate to the Go server directory first.

```bash
cd TestChatServer/go
go run chatroom.go
```

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

### Get All Processing Instruction Children

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/rexml-3.4.4/doc/rexml/tasks/rdoc/element.rdoc

The `instructions` method retrieves all processing instruction nodes. The example demonstrates mapping these instructions to their string format.

```ruby
xml_string = <<-EOT
  <root>
    <?target0 foo?>
    <?target1 bar?>
  </root>
EOT
d = REXML::Document.new(xml_string)
instructions = d.root.instructions.map {|instruction| instruction.to_s }
instructions # => ["<?target0 foo?>", "<?target1 bar?>"]
```

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

### Get All Comment Children

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/rexml-3.4.4/doc/rexml/tasks/rdoc/element.rdoc

Use the `comments` method to retrieve all XML comment nodes. The example maps the results to their string representation for easy viewing.

```ruby
xml_string = <<-EOT
  <root>
    <!--foo-->
    <!--bar-->
  </root>
EOT
d = REXML::Document.new(xml_string)
d.root.comments.map {|comment| comment.to_s } # => ["foo", "bar"]
```

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

### Try a Pod Demo Project

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/cocoapods-try-1.2.0/README.md

Use this command to quickly try the demo project of a specified CocoaPod.

```bash
$ pod try POD_NAME
```

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

### Start TestChat Server (Python)

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/ios/Pods/SocketRocket/README.md

Launch the Python-based chatroom server. This command should be run after setting up dependencies.

```bash
python TestChatServer/py/chatroom.py
```

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

### Start Metro Bundler

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/README.md

Starts the Metro JavaScript bundler for React Native development. Use npm or Yarn to run this command from the project's root directory.

```sh
# Using npm
npm start

# OR using Yarn
yarn start
```

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

### Launch Document Scanner (Basic Usage)

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/README.md

Import the `launchScanner` function and call it without any options to initiate the document scanner with default settings.

```javascript
import { launchScanner } from 'react-native-document-scanner';

// Basic usage
const result = await launchScanner();
```

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

### Launch Scanner with Location EXIF

Source: https://context7.com/dariyd/react-native-document-scanner/llms.txt

This example demonstrates launching the scanner with options to include EXIF data and location data. The behavior varies based on whether permission has been requested, granted, or denied.

```typescript
// Permission behavior summary
const result = await launchScanner({ includeExif: true, includeLocationExif: true });

// Case 1 — Permission NOT yet requested:
//   → System permission dialog is shown automatically
//   → Scanning proceeds immediately (without GPS on this first run)
//   → On the NEXT scan the permission will already be granted

// Case 2 — Permission already GRANTED:
//   → Location is fetched silently before opening the scanner UI
//   → GPS fields are populated in result.images[].exif

// Case 3 — Permission DENIED:
//   → Scanning proceeds normally, GPS fields are simply absent
//   → No error is thrown; result.error remains false
```

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

### Install CocoaPods Dependencies

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/README.md

Installs dependencies for the iOS project using CocoaPods. Run 'bundle install' once to install the bundler, and 'bundle exec pod install' after updating native dependencies.

```sh
bundle install

bundle exec pod install
```

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

### Printf for Basic Formatting

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/ios/Pods/fmt/README.md

A concise example of using printf for formatted output, contrasting with the verbosity of iostreams.

```c
printf("%.2f\n", 1.23456);
```

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

### Install Securerandom Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/securerandom-0.4.1/README.md

Add the gem to your application's Gemfile and run bundle install, or install it directly using gem install.

```ruby
gem 'securerandom'
```

```bash
$ bundle install
```

```bash
$ gem install securerandom
```

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

### Install Fourflusher Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/fourflusher-2.3.1/README.md

After adding the gem to your Gemfile, execute bundle to install it. Alternatively, you can install it directly using the gem install command.

```bash
$ bundle
```

```bash
$ gem install fourflusher
```

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

### launchScanner with ScanOptions

Source: https://context7.com/dariyd/react-native-document-scanner/llms.txt

Demonstrates how to launch the document scanner with custom configuration options for image quality, base64 encoding, and EXIF/GPS metadata.

```APIDOC
## `launchScanner` with `ScanOptions`

### Description
Initiates the document scanning process with configurable options.

### Method
`launchScanner(options?: ScanOptions): Promise<ScanResult>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
`ScanOptions` object:
- **quality** (number) - Optional - Compression ratio (0.0–1.0). Lower values result in smaller files.
- **includeBase64** (boolean) - Optional - If true, adds a `base64` string to each `ImageObject`.
- **includeExif** (boolean) - Optional - If true, embeds and returns EXIF metadata (timestamps, device, dimensions).
- **includeLocationExif** (boolean) - Optional - If true, also embeds GPS coordinates in EXIF. Requires location permissions.

### Request Example
```typescript
import { launchScanner, ScanOptions } from '@dariyd/react-native-document-scanner';

const options: ScanOptions = {
  quality: 0.8,
  includeBase64: false,
  includeExif: true,
  includeLocationExif: true,
};

const result = await launchScanner(options);
```

### Response
#### Success Response (`ScanResult`)
- **images** (Array<ImageObject>) - An array of scanned image objects.
- **didCancel** (boolean) - True if the user dismissed the scanner.
- **error** (boolean) - True if an error occurred.
- **errorMessage** (string) - Description of the error if `error` is true.

#### Response Example
```json
{
  "uri": "file:///data/user/0/com.myapp/cache/a1b2c3d4.jpg",
  "fileName": "a1b2c3d4.jpg",
  "type": "image/jpeg",
  "width": 2480,
  "height": 3508,
  "fileSize": 153600,
  "base64": "/9j/4AAQSkZJRgABAQAAAQABAAD...", // only if includeBase64: true
  "exif": { ... } // only if includeExif: true
}
```
```

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

### Build Process Flow (New Architecture)

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/CODEGEN_EXPLAINED.md

Illustrates the steps involved when the New Architecture is enabled, from `pod install` to Xcode build, highlighting codegen's role.

```text
Podfile: ENV['RCT_NEW_ARCH_ENABLED'] = '1'
   ↓
   prepare_react_native_project!
   ↓
   Reads package.json → Finds codegenConfig
   ↓
   Reads src/NativeDocumentScanner.ts
   ↓
   Generates RNDocumentScannerSpec files in ios/build/generated/ios/
   ↓
   Creates ReactCodegen.podspec with generated code
   ↓
   Installs ReactCodegen pod
```

```text
Compiles generated C++/Obj-C++ files
   ↓
   Compiles your DocumentScanner.m (which imports generated .h)
   ↓
   Links everything together
   ↓
   App has TurboModule support!
```

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

### Run Benchmark Tests

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/ios/Pods/fmt/README.md

Execute the speed or bloat tests after setting up the benchmark repository.

```bash
make speed-test
```

```bash
make bloat-test
```

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

### Install cocoapods-deintegrate

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/cocoapods-deintegrate-1.0.5/README.md

Install the cocoapods-deintegrate plugin using the gem command. You may need to use sudo depending on your Ruby installation.

```bash
$ [sudo] gem install cocoapods-deintegrate
```

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

### Launch Document Scanner with Options

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/README.md

Call `launchScanner` with an options object to configure parameters like image quality and whether to include Base64 data.

```javascript
import { launchScanner } from 'react-native-document-scanner';

// With options
const result = await launchScanner({
  quality: 0.8,
  includeBase64: false,
});
```

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

### Install Logger Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/logger-1.7.0/README.md

Add the logger gem to your application's Gemfile and run bundle, or install it directly using the gem install command.

```ruby
gem 'logger'
```

```bash
$ bundle
```

```bash
$ gem install logger
```

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

### Clone and Build Benchmark Repository

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/ios/Pods/fmt/README.md

Clone the benchmark repository and configure it with CMake to prepare for running performance tests.

```bash
git clone --recursive https://github.com/fmtlib/format-benchmark.git
cd format-benchmark
cmake .
```

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

### Dry Run System Dependency Installation for Folly

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/ios/Pods/RCT-Folly/README.md

Preview the system dependencies that `getdeps.py` would install without actually performing the installation. Useful for verification.

```bash
./build/fbcode_builder/getdeps.py install-system-deps --dry-run --recursive
```

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

### Import Scanner Launch Function

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/README.md

Import the `launchScanner` function from the library to initiate the document scanning process.

```javascript
import {launchScanner} from 'react-native-document-scanner';
```

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

### GhInspector::Inspector Initialization and Usage

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/gh_inspector-1.1.3/README.md

Demonstrates how to initialize the GhInspector::Inspector class and use its primary methods to search for issues.

```APIDOC
## GhInspector::Inspector

### Description

The `GhInspector::Inspector` class is the main public API for querying GitHub issues. It allows users to search for issues related to specific exceptions or by providing a direct query string.

### Initialization

To get started, create an instance of `GhInspector::Inspector` by providing the GitHub username and repository name.

```ruby
require 'gh_inspector'
inspector = GhInspector::Inspector.new "username", "repository"
```

### Methods

#### `search_exception(an_error, delegate = nil)`

Searches for issues related to a given exception.

- **an_error** (Exception) - The exception to search for.
- **delegate** (Object, optional) - An optional custom object to handle UI updates and callbacks.

```ruby
inspector.search_exception an_error, ArtsyUI.new
```

#### `search_query(query, delegate = nil)`

Performs a direct search for issues based on a query string.

- **query** (String) - The search query string.
- **delegate** (Object, optional) - An optional custom object to handle UI updates and callbacks.

```ruby
inspector.search_query "Someone set us up the bomb", FastlaneUI.new
```

### Custom Delegate Protocol

Custom objects used as delegates must conform to the following protocol:

- `inspector_started_query(query, inspector)`: Called when the investigation begins.
- `inspector_successfully_recieved_report(report, inspector)`: Called when a report with issues is received (Deprecated, use `inspector_successfully_received_report`).
- `inspector_successfully_received_report(report, inspector)`: Called when a report with issues is successfully received.
- `inspector_recieved_empty_report(report, inspector)`: Called when a report is received but contains no issues (Deprecated, use `inspector_received_empty_report`).
- `inspector_received_empty_report(report, inspector)`: Called when an empty report is received.
- `inspector_could_not_create_report(error, query, inspector)`: Called when there are networking issues during report creation.
```

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

### Install Addressable Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/addressable-2.8.7/README.md

Command to install the Addressable gem using RubyGems.

```bash
$ gem install addressable
```

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

### Install cocoapods-plugins Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/cocoapods-plugins-1.0.0/README.md

Install the cocoapods-plugins gem using the RubyGems package manager.

```bash
$ gem install cocoapods-plugins
```

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

### Install CLAide Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/claide-1.1.0/README.md

Install the CLAide gem using the RubyGems package manager.

```bash
$ [sudo] gem install claide
```

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

### Write to a File

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/ios/Pods/fmt/README.md

Example of writing formatted output to a file using fmt::output_file. This method is noted to be significantly faster than fprintf.

```cpp
#include <fmt/os.h>

int main() {
  auto out = fmt::output_file("guide.txt");
  out.print("Don't {}\n", "Panic");
}
```

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

### Install Typhoeus Gem Manually

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/typhoeus-1.5.0/README.md

Install the Typhoeus gem directly using the gem command.

```bash
gem install typhoeus
```

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

### Running Minitest Tests from the Command Line

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/minitest-5.26.0/README.rdoc

This shows how to run Minitest tests directly from the command line using the ruby interpreter. It includes example output and runtime options.

```bash
% ruby -Ilib:test test/minitest/test_minitest_test.rb
```

```bash
% ruby -Ilib:test test/minitest/test_minitest_test.rb --help
```

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

### Initialize Algolia Client and Index

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/algoliasearch-1.27.5/README.md

This snippet shows how to initialize the Algolia client with your application ID and API key, and then create an index object for a specific index name.

```APIDOC
## Initialize Algolia Client and Index

### Description
Initialize the Algolia client with your application ID and API key, and then create an index object for a specific index name.

### Method
Ruby SDK

### Code
```ruby
Algolia.init(application_id: 'YourApplicationID',
             api_key:        'YourAPIKey')
index = Algolia::Index.new('your_index_name')
```
```

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

### Install Concurrent Ruby Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/concurrent-ruby-1.3.3/README.md

Install the concurrent-ruby gem using the RubyGems package manager.

```shell
gem install concurrent-ruby
```

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

### Load and Call C Function with Ruby-FFI

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/ffi-1.17.2/README.md

Demonstrates how to load the C standard library and attach a function to call it from Ruby. Ensure 'ffi' is required.

```ruby
require 'ffi'

module MyLib
  extend FFI::Library
  ffi_lib 'c'
  attach_function :puts, [ :string ], :int
end

MyLib.puts 'Hello, World using libc!'
```

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

### Install Atomos Gem

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/atomos-0.1.3/README.md

Install the Atomos gem directly using this command if you are not using a Gemfile.

```bash
$ gem install atomos
```

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

### Basic Mach-O File Examination in Ruby

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/ruby-macho-2.5.1/README.md

Demonstrates how to open a Mach-O file, retrieve its file type, iterate through load commands, and access specific load commands like LC_VERSION_MIN_MACOSX.

```ruby
require 'macho'

file = MachO::MachOFile.new("/path/to/my/binary")

# get the file's type (object, dynamic lib, executable, etc)
file.filetype # => :execute

# get all load commands in the file and print their offsets:
file.load_commands.each do |lc|
  puts "#{lc.type}: offset #{lc.offset}, size: #{lc.cmdsize}"
end

# access a specific load command
lc_vers = file[:LC_VERSION_MIN_MACOSX].first
puts lc_vers.version_string # => "10.10.0"
```

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

### List Installed CocoaPods Plugins

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/cocoapods-plugins-1.0.0/README.md

View all installed CocoaPods plugins along with their versions and any pre/post-install hooks.

```bash
$ pod plugins installed
```

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

### Build and Push Gem (rbenv)

Source: https://github.com/dariyd/react-native-document-scanner/blob/main/example/vendor/bundle/ruby/3.1.0/gems/json-2.15.1/README.md

Steps to build and push a gem using rbenv, including setting the shell and running build/push commands.

```bash
rbenv shell 2.6.5
rake build
gem push pkg/json-2.3.0.gem
```