Mdocument-scanner NPM | npm.io

0.0.5 • Published 4 months ago

Install

Weekly downloads

-

License

MIT

Repository

Last release

4 months ago

mdocument-scanner

Document scanner - This is a Capacitor plugin that lets you scan documents using Android and iOS.

Install

npm install mdocument-scanner
npx cap sync

Android Configuration

Add these lines to android/app/src/main/res/xml/file_paths.xml

<?xml version="1.0" encoding="utf-8" ?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
    <external-path name="external_files" path="."/>
    <cache-path name="mlkit_docscan_ui_client" path="." />
</paths>

iOS Configuration

iOS requires the following usage description be added and filled out for your app in Info.plist:

NSCameraUsageDescription (Privacy - Camera Usage Description)

API

scanDocument(...)

scanDocument(options: ScanDocumentOptions) => Promise<ScanDocumentResponse>

Param	Type
`options`	ScanDocumentOptions

Returns: Promise<ScanDocumentResponse>

Interfaces

ScanDocumentResponse

Prop	Type	Description
`scannedFile`	string	This is an array with either file path or base64 for the document scan.
`status`	ScanDocumentResponseStatus	The status lets you know if the document scan completes successfully, or if the user cancels before completing the document scan.

ScanDocumentOptions

Prop	Type	Description	Default
`maxNumDocuments`	number	Android only: The maximum number of photos an user can take (not counting photo retakes)	: 1
`responseType`	ResponseType	The response comes back in this format on success. It can be the document scan image file paths or base64 images.	: ResponseType.ImageFilePath

Enums

ScanDocumentResponseStatus

Members	Value	Description
`Success`	'success'	The status comes back as success if the document scan completes successfully.
`Cancel`	'cancel'	The status comes back as cancel if the user closes out of the camera before completing the document scan.

ResponseType

Members	Value	Description
`Base64`	'base64'	Use this response type if you want document scan returned as base64 images.
`ImageFilePath`	'imageFilePath'	Use this response type if you want document scan returned as inmage file paths.

capacitor plugin native

acorn acorn-jsx ajv ansi-colors ansi-regex ansi-styles argparse array-buffer-byte-length array-includes array-union array.prototype.findlastindex array.prototype.flat array.prototype.flatmap arraybuffer.prototype.slice astral-regex at-least-node available-typed-arrays balanced-match brace-expansion braces call-bind callsites chalk chevrotain color-convert color-name colorette concat-map cosmiconfig cross-spawn data-view-buffer data-view-byte-length data-view-byte-offset debug deep-is define-data-property define-properties dir-glob doctrine emoji-regex enquirer error-ex es-abstract es-define-property es-errors es-object-atoms es-set-tostringtag es-shim-unscopables es-to-primitive escape-string-regexp eslint-config-prettier eslint-import-resolver-node eslint-module-utils eslint-plugin-import eslint-scope eslint-utils eslint-visitor-keys espree esprima esquery esrecurse estraverse esutils fast-deep-equal fast-glob fast-json-stable-stringify fast-levenshtein fastq file-entry-cache fill-range flat-cache flatted for-each fs-extra fs.realpath function-bind function.prototype.name functional-red-black-tree functions-have-names get-intrinsic get-stdin get-symbol-description github-slugger glob glob-parent globals globalthis globby gopd graceful-fs has-bigints has-flag has-property-descriptors has-proto has-symbols has-tostringtag hasown ignore import-fresh imurmurhash inflight inherits internal-slot is-array-buffer is-arrayish is-bigint is-boolean-object is-callable is-core-module is-data-view is-date-object is-extglob is-fullwidth-code-point is-glob is-negative-zero is-number is-number-object is-regex is-shared-array-buffer is-string is-symbol is-typed-array is-weakref isarray isexe java-parser js-tokens js-yaml json-buffer json-parse-even-better-errors json-schema-traverse json-stable-stringify-without-jsonify json5 jsonfile keyv levn lines-and-columns lodash lodash.merge lodash.truncate merge2 micromatch minimatch minimist ms natural-compare object-inspect object-keys object.assign object.fromentries object.groupby object.values once optionator parent-module parse-json path-is-absolute path-key path-parse path-type picocolors picomatch possible-typed-array-names prelude-ls progress punycode queue-microtask regexp-to-ast regexp.prototype.flags regexpp require-from-string resolve resolve-from reusify run-parallel safe-array-concat safe-regex-test semver set-function-length set-function-name shebang-command shebang-regex side-channel signal-exit slash slice-ansi sprintf-js string-width string.prototype.trim string.prototype.trimend string.prototype.trimstart strip-ansi strip-bom strip-json-comments supports-color supports-preserve-symlinks-flag table text-table to-regex-range tree-kill tsconfig-paths tslib tsutils type-check type-fest typed-array-buffer typed-array-byte-length typed-array-byte-offset typed-array-length unbox-primitive universalify untildify uri-js v8-compile-cache which which-boxed-primitive which-typed-array word-wrap wrap-ansi wrappy yaml

4 months ago

10 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago