Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-textract-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`TextractClient`) and the commands you need, for example `AnalyzeDocumentCommand`:\n\n```javascript\n//JavaScript\nconst {\n TextractClient\n} = require(\"@aws-sdk/client-textract-browser/TextractClient\");\nconst {\n AnalyzeDocumentCommand\n} = require(\"@aws-sdk/client-textract-browser/commands/AnalyzeDocumentCommand\");\n```\n\n```javascript\n//TypeScript\nimport { TextractClient } from \"@aws-sdk/client-textract-browser/TextractClient\";\nimport { AnalyzeDocumentCommand } from \"@aws-sdk/client-textract-browser/commands/AnalyzeDocumentCommand\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst textract = new TextractClient({ region: \"region\" });\n//clients can be shared by different commands\nconst params = {\n Document: {\n /**an object specifying Document*/\n },\n FeatureTypes: [\n /**a list of string*/\n ]\n};\nconst analyzeDocumentCommand = new AnalyzeDocumentCommand(params);\ntextract\n .send(analyzeDocumentCommand)\n .then(data => {\n // do something\n })\n .catch(error => {\n // error handling\n });\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await textract.send(analyzeDocumentCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ntextract.send(analyzeDocumentCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/@aws-sdk/client-textract-browser/Textract\";\nconst textract = new AWS.Textract({ region: \"region\" });\ntextract.analyzeDocument(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await textract.send(analyzeDocumentCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-textract-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-textract-browser has been renamed to @aws-sdk/client-textract. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Textract","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.5","@aws-sdk/json-parser":"^0.1.0-preview.5","@aws-sdk/core-handler":"^0.1.0-preview.5","@aws-sdk/json-builder":"^0.1.0-preview.5","@aws-sdk/signature-v4":"^0.1.0-preview.7","@aws-sdk/config-resolver":"^0.1.0-preview.5","@aws-sdk/middleware-stack":"^0.1.0-preview.6","@aws-sdk/retry-middleware":"^0.1.0-preview.5","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.6","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.5","@aws-sdk/signing-middleware":"^0.1.0-preview.7","@aws-sdk/url-parser-browser":"^0.1.0-preview.5","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.6","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.6","@aws-sdk/stream-collector-browser":"^0.1.0-preview.5","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.5","@aws-sdk/middleware-header-default":"^0.1.0-preview.5"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-textract-browser_0.1.0-preview.3_1568908742411_0.9040354109064843","host":"s3://npm-registry-packages"}},"0.1.0-preview.4":{"name":"@aws-sdk/client-textract-browser","version":"0.1.0-preview.4","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-textract-browser@0.1.0-preview.4","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"2066fdb6fc5235631a2f76caeb52e8856c763f39","tarball":"https://registry.npmjs.org/@aws-sdk/client-textract-browser/-/client-textract-browser-0.1.0-preview.4.tgz","fileCount":314,"integrity":"sha512-f2b6oehIEIFNhvxaUctD/+vMQUKGO2StQZS0ck6FwuIzxpNCJrbbqzilfV5SkNHL9ldILaG0VMzJrEieSBv7mQ==","signatures":[{"sig":"MEQCIBNByfMx/ITSFhLsxMAJD7Lc7DVay55atRRinnMdktqcAiByBu0ZzC7V2s8VAH4ZZAQyhaqu5D+EyqmXOc3N0hevYA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":206305,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJduM+ZCRA9TVsSAnZWagAAEz4P+wUX9ef79REyAjmtnuPH\nfUgavvZX0XAhDqvmTH08D9jcRo9+BKBPT1Hm1butTa+H9kdBaTcsDPEW45bV\n2nqksKIMmCJ2bJcrggpWCExmbRKOvHIaRI7YZYqYaZV8U0pG/LP+kNsvNPYF\nxGYHY2WkzfwILNXIcn4YDssih0S8TQxA8wUm+M5EnHXUFlhTpGxbOAlgWR2J\nDBk+ZyY+/EP4TeVRbK2RD/JDrB2KKTYj5fj2x2d2aFs2KYmc2wmKMNQP2zwO\n/XJP18G6D+t+MWHtekWiMqI+CvhG6+rLgfqbxVs7UW6ApHQvU/5KR3IBHZv+\nwVuBzVbIc5v0poelZuIaM20Hvvhistvbo5cPXwPDlYzAda3pMUF3njuMmIyv\nCpHuNL9kR89sP2JsbbkNIQ3l0hpJ/HAywWbJyIbb6QL2jza5C3qZUvkZ42G7\ncmZdJ63rOBneo5e3VxNfyxjZHppFT9eMuJHYDvLoBRPg0hOLKxyWgIiMiu8r\nQmiDAMvX0yNwQfmcUBNjhsQnJuPK4y+0Jz3fRnnGl5ofFlTBKqhkwyJsH/Jk\nyVlKmRR+SZpKOZQpdd1cjACzO2ONrKDidnJIsdaZsyiAeaxjXIUwLs8GwaR8\nZt1uKi6WoPoEgCPWRc7HGw2RolY+mitkKAZC2/XOwk68b4Wuvc5OxdVa8Te9\n52pF\r\n=Q65a\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-textract-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-textract-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-textract-browser)\n\n## Description\n\nAmazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-textract-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`TextractClient`) and the commands you need, for example `AnalyzeDocumentCommand`:\n\n```javascript\n//JavaScript\nconst {\n TextractClient,\n AnalyzeDocumentCommand\n} = require(\"@aws-sdk/client-textract-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n TextractClient,\n AnalyzeDocumentCommand\n} from \"@aws-sdk/client-textract-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst textract = new TextractClient({ region: \"region\" });\n//clients can be shared by different commands\nconst params = {\n Document: {\n /**an object specifying Document*/\n },\n FeatureTypes: [\n /**a list of string*/\n ]\n};\nconst analyzeDocumentCommand = new AnalyzeDocumentCommand(params);\ntextract\n .send(analyzeDocumentCommand)\n .then(data => {\n // do something\n })\n .catch(error => {\n // error handling\n });\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await textract.send(analyzeDocumentCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ntextract.send(analyzeDocumentCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-textract-browser\";\nconst textract = new AWS.Textract({ region: \"region\" });\ntextract.analyzeDocument(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await textract.send(analyzeDocumentCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-textract-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-textract-browser has been renamed to @aws-sdk/client-textract. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Textract","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.6","@aws-sdk/json-parser":"^0.1.0-preview.6","@aws-sdk/core-handler":"^0.1.0-preview.6","@aws-sdk/json-builder":"^0.1.0-preview.6","@aws-sdk/signature-v4":"^0.1.0-preview.8","@aws-sdk/config-resolver":"^0.1.0-preview.6","@aws-sdk/middleware-stack":"^0.1.0-preview.7","@aws-sdk/retry-middleware":"^0.1.0-preview.6","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.7","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.6","@aws-sdk/signing-middleware":"^0.1.0-preview.8","@aws-sdk/url-parser-browser":"^0.1.0-preview.6","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.6","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.7","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.7","@aws-sdk/stream-collector-browser":"^0.1.0-preview.6","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.6","@aws-sdk/middleware-header-default":"^0.1.0-preview.6"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-textract-browser_0.1.0-preview.4_1572392856943_0.7013275508208325","host":"s3://npm-registry-packages"}},"0.1.0-preview.5":{"name":"@aws-sdk/client-textract-browser","version":"0.1.0-preview.5","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-textract-browser@0.1.0-preview.5","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"e1c1ec324f11f8e76e99ad3b324889f381a6fb8a","tarball":"https://registry.npmjs.org/@aws-sdk/client-textract-browser/-/client-textract-browser-0.1.0-preview.5.tgz","fileCount":314,"integrity":"sha512-MarZsxseJr678OyngQTwUYcho2GXyQ3QtbtSjb8WHpAHCBH6tmQNKWJRLMG9iufetBIGIyH+wV3jix8C1Y6AGw==","signatures":[{"sig":"MEYCIQC0j5Jp7eSb2X47hR446nyfjCBhkkpzY1ft1UeJu1qEmAIhAPEDyOWsbUKxxqUj9aH1JbRGbG2Dwf2+uGnwxBzjQVrr","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":206549,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdueKJCRA9TVsSAnZWagAAqycQAI9GJdOCVGvnYsDcpVr0\nnD1p/XQgAmevx9URnN00OTsi4g90ub8ckF9Jnn2OoTyEvkYrEcpK5sUDlfba\nKiuWzin4ZwSxPKj8lxOWQNWMJqhgULg/o3+irxz0+EzdeHXwIrDMXIQ6GTiw\n3TpgY87KgVqEeRRWAPgdtbky5h+ITG1wOslJRLtz0mFRHRx0lgPAPjG/HVc8\ndZkEk3lkDl9FaSrU3047Z2ME54PQkf9ioheLRyvu61Dj0e+Nr53DHYs5/NrA\n0+JGXQWGXGPI17jJ4ncvW003pUsWE+qr3RaOuPSYvixpvKIZ1mnylMe2Z9IE\ndRbtCOC4I70auW1vK8fda/ERFLkBEufp2wrHbntfmbWzi/z6e2mzL7VvF4iE\nerchsgAJJ3m+4wDmdqCe7wa4424iS97a1iubub9c0zqs/NMQmU+6WORTKn2P\nZJDvbK/pLfLHSzWHeiUXI7ixyLAL3wc2awQnMvNL7HDWw0bxAFJJibXF3g9x\nIgDxpJG9CJPxiyIsXfCbZUEmCQP6U6SwGdjFQ1sEPb/PGWBrUF1lJFIJ74Y0\nmK+hW9HbjrDuIIpUR6OxAnLV+JXEljDmqnEXyuxAgsh+ceonAG8FiFKDvyaY\nDIKIFIdkwLyk/cKmJ5kYXMB9xIWo7GW8xppfQZ6TWId8nIHpq84b7KGWCLdQ\nItsx\r\n=E8WA\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-textract-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-textract-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-textract-browser)\n\n## Description\n\nAmazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-textract-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`TextractClient`) and the commands you need, for example `AnalyzeDocumentCommand`:\n\n```javascript\n//JavaScript\nconst {\n TextractClient,\n AnalyzeDocumentCommand\n} = require(\"@aws-sdk/client-textract-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n TextractClient,\n AnalyzeDocumentCommand\n} from \"@aws-sdk/client-textract-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst textract = new TextractClient({ region: \"region\" });\n//clients can be shared by different commands\nconst params = {\n Document: {\n /**an object specifying Document*/\n },\n FeatureTypes: [\n /**a list of string*/\n ]\n};\nconst analyzeDocumentCommand = new AnalyzeDocumentCommand(params);\ntextract\n .send(analyzeDocumentCommand)\n .then(data => {\n // do something\n })\n .catch(error => {\n // error handling\n });\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await textract.send(analyzeDocumentCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ntextract.send(analyzeDocumentCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-textract-browser\";\nconst textract = new AWS.Textract({ region: \"region\" });\ntextract.analyzeDocument(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await textract.send(analyzeDocumentCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-textract-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-textract-browser has been renamed to @aws-sdk/client-textract. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Textract","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.9","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.8","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.8","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.7","@aws-sdk/signing-middleware":"^0.1.0-preview.9","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.8","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-textract-browser_0.1.0-preview.5_1572463241179_0.9120765944771372","host":"s3://npm-registry-packages"}},"0.1.0-preview.6":{"name":"@aws-sdk/client-textract-browser","version":"0.1.0-preview.6","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-textract-browser@0.1.0-preview.6","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"5c8c2113a948a449009466ebef8fa76616fac9ff","tarball":"https://registry.npmjs.org/@aws-sdk/client-textract-browser/-/client-textract-browser-0.1.0-preview.6.tgz","fileCount":314,"integrity":"sha512-nyu/P/jq8vCjmpIZONUiZOHQT4P+kCoiD8UGVDiCFoTCrj8Dpqu6ooncEQ6BkLTBxeGi5l5Bmh/BSkpU98AAQw==","signatures":[{"sig":"MEQCIDqXeklU1RLYg8EONhPhC5vWkzpc6jUWDbgvuE0DvSl8AiB8r3c/BWQXC7VvQxqu13qtFqNwJB/fXWa4btWAYw+V6Q==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":206819,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd1FPECRA9TVsSAnZWagAAOk8QAI9eRUhBSBhDYTi2zWwh\nn45wUL11/gOQ8ZFODkpIy5dPNkGwn5XRJ/Fit3FjBCE75UVgtg9cnAlZpmBI\ng8pfDEhWXDfI8ZD+HWze9ec/iJ/RuerDk25p52TczLL2zPpjuqflyn7+uX2o\nMGoitacIErjNR+DpQG9iJjHevEQjdSVFwkKoaGfrRTx3GF6ELoI8RWys5iUL\nfsPo5/Z54Gn6ALYDJiHVlROrVoqhrKkoe2+CuWl2VH2EfcuM6VWZdrw3iqR8\nIvGsSJzfz2sYp2zmxtuVSyVGEKgW7o8OgIty5DC10oVNhQWcxovV0oRqxucT\n0Xi2lUQb0UIZJVQU3DM1GnDHW6aNOpqNS0/NN84EmFZlYdBRnE6QkDfOvo0J\npaReOQi7vQUJLrnkwqWDj5q9frvHz01lhMODIaLM0JTPJ+fZRtg4V6k8nf+3\n6BnJJC12g/NhgVnnxfCdMpHf0UbkP+5aBPIk/KgqbRFdGnRQIDARREmHqcEi\nwiFc8Vq7pPq5j9ra+ZmHr4nMbp081eWqPrHLUXiAQT38QZpWbAXCmr9Xtzci\nCS54u8wKho1Qr5evRaYYivThZpSatWxNA14jtPyymfMSpUjaGhwhBZfcddF0\nzc7WjuhEjerV/j87KXuJJ4rhRh7l9uDo05FzrHkJ9ZoH8d9TUuC1zO/HPna7\nrEnc\r\n=Xrlm\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-textract-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-textract-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-textract-browser)\n\n## Description\n\nAmazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-textract-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`TextractClient`) and the commands you need, for example `AnalyzeDocumentCommand`:\n\n```javascript\n//JavaScript\nconst {\n TextractClient,\n AnalyzeDocumentCommand\n} = require(\"@aws-sdk/client-textract-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n TextractClient,\n AnalyzeDocumentCommand\n} from \"@aws-sdk/client-textract-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst textract = new TextractClient({ region: \"region\" });\n//clients can be shared by different commands\nconst params = {\n Document: {\n /**an object specifying Document*/\n },\n FeatureTypes: [\n /**a list of string*/\n ]\n};\nconst analyzeDocumentCommand = new AnalyzeDocumentCommand(params);\ntextract\n .send(analyzeDocumentCommand)\n .then(data => {\n // do something\n })\n .catch(error => {\n // error handling\n });\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await textract.send(analyzeDocumentCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ntextract.send(analyzeDocumentCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-textract-browser\";\nconst textract = new AWS.Textract({ region: \"region\" });\ntextract.analyzeDocument(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await textract.send(analyzeDocumentCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-textract-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-textract-browser has been renamed to @aws-sdk/client-textract. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Textract","directories":{},"_nodeVersion":"10.16.3","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.10","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.9","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.8","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.8","@aws-sdk/signing-middleware":"^0.1.0-preview.10","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.9","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-textract-browser_0.1.0-preview.6_1574196163860_0.8738080700420221","host":"s3://npm-registry-packages"}}},"time":{"created":"2019-09-09T17:45:13.465Z","modified":"2025-03-27T18:47:12.080Z","0.1.0-preview.2":"2019-09-09T17:45:13.802Z","0.1.0-preview.3":"2019-09-19T15:59:02.537Z","0.1.0-preview.4":"2019-10-29T23:47:37.077Z","0.1.0-preview.5":"2019-10-30T19:20:41.377Z","0.1.0-preview.6":"2019-11-19T20:42:44.042Z"},"author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","description":"Browser SDK for Amazon Textract","maintainers":[{"email":"osa-3p@amazon.com","name":"amzn-oss"},{"email":"aws-sdk-js-automation@amazon.com","name":"aws-sdk-bot"}],"readme":"","readmeFilename":""}