MCPcopy Create free account
hub / github.com/dariyd/react-native-document-scanner / ScanOptions

Interface ScanOptions

index.d.ts:69–105  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

67}
68
69export interface ScanOptions {
70 /**
71 * Image quality from 0 to 1 (default: 1)
72 * Lower values reduce file size
73 *
74 * @default 1
75 */
76 quality?: number;
77
78 /**
79 * If true, includes base64 string of the image in the result
80 * Avoid using on large image files due to performance impact
81 *
82 * @default false
83 */
84 includeBase64?: boolean;
85
86 /**
87 * If true, includes EXIF metadata (timestamps, device info, dimensions) in the result
88 * EXIF data is also embedded in the saved image file
89 *
90 * @default false
91 */
92 includeExif?: boolean;
93
94 /**
95 * If true, includes GPS coordinates in the EXIF metadata
96 * Requires location permission (the package will request it automatically)
97 * If permission is denied, scanning still works but GPS fields are skipped
98 *
99 * iOS: Requires NSLocationWhenInUseUsageDescription in Info.plist
100 * Android: Requires ACCESS_FINE_LOCATION permission
101 *
102 * @default false
103 */
104 includeLocationExif?: boolean;
105}
106
107/**
108 * Launch the document scanner

Callers

nothing calls this directly

Calls

no outgoing calls

Tested by

no test coverage detected