Shen-dynamsoft-code-parser NPM

Dynamsoft Code Parser for Your Website

Dynamsoft Code Parser is designed to parse data strings (usually encrypted in barcodes, machine readable zones, etc.) into human-readable information. The JavaScript edition is based on WebAssembly and offers great speed and accuracy. With its well-designed API, you can equip your web pages with a code parser with just a few lines of code.

In this guide, you will learn step by step on how to integrate the DCP-JS SDK into your website.

Table of Contents

Hello World - Simplest Implementation
Building your own page
API Documentation

Hello World - Simplest Implementation

Let’s start with the "Hello World" example of the SDK which demonstrates how to use the minimum code to enable a web page to parse codes into readable info.

The complete code of the "Hello World" example is shown below:

Since the code that needs parsing is usually hard to understand and often comes from images, we choose an online image which contains a US driver license to demonstrate how to parse the code with the help of BarcodeReader . Please make sure your device is connected to the Internet when opening the following example in your browser.

<!DOCTYPE html>
<html>

<body>
    <script src="https://cdn.jsdelivr.net/npm/dynamsoft-javascript-barcode@9.0.2/dist/dbr.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/dynamsoft-code-parser@1.1.0/dist/dcp.js"></script>
  <script>
        // Specifies a license 
        Dynamsoft.DBR.BarcodeReader.license = 'DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9';
        Dynamsoft.DCP.CodeParser.license = 'DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9';
        // Initializes and uses the SDK
        (async () => {
            try {
                let reader = await Dynamsoft.DBR.BarcodeReader.createInstance();
                let parser = await Dynamsoft.DCP.CodeParser.createInstance();

                await parser.setCodeFormat(Dynamsoft.DCP.EnumCodeFormat.CF_AUTO);

                // Decode the driver license with BarcodeReader
                let results = await reader.decode(
                    "https://demo.dynamsoft.com/samples/dbr/js/4.use-case/SampleDriversLicense.jpg");

                let info = "";
                for (let result of results) {
                    // Parse the "code" retrieved from the barcode
                    info = await parser.parseData(result.barcodeBytes);
                    // Show the information
                    alert(JSON.stringify(info));
                    // Check the readable information in the console
                    console.log(info);
                }
            } catch (ex) {
                alert(ex);
            }
        })();
    </script>
</body>

</html>

About the code

license: This property specifies a license key. Read more on Specify the license.
createInstance(): This method creates a CodeParser object.
setCodeFormat: This method sets the code’s format before parsing.
parseData: This method parses the code.

For the rest of the code, please read more about DBR-JS User Guide.

Building your own page

Include the SDK

Use a CDN

The simplest way to include the SDK is to use either the jsDelivr or UNPKG CDN. The "hello world" example above uses jsDelivr.

jsDelivr

<script src="https://cdn.jsdelivr.net/npm/dynamsoft-code-parser@1.1.0/dist/dcp.js"></script>

UNPKG

<script src="https://unpkg.com/dynamsoft-code-parser@1.1.0/dist/dcp.js"></script>

Host the SDK yourself

Besides using the CDN, you can also download the SDK and host its files on your own website / server before including it in your application.

Options to download the SDK:

yarn
```
yarn add dynamsoft-code-parser
```

npm

npm install dynamsoft-code-parser --save

Depending on how you downloaded the SDK and where you put it, you can typically include it like this:

<script src="/dynamsoft-code-parser-js-1.1.0/dist/dcp.js"></script>

<script src="/node_modules/dynamsoft-code-parser/dist/dcp.js"></script>

Configure the SDK

Before using the SDK, you need to configure a few things.

Specify the license

The SDK requires a license to work, use the API license to specify the license key.

//You can visit https://www.dynamsoft.com/customer/license/trialLicense?utm_source=github&product=dcp&package=js to get your own trial license good for 30 days. 
Dynamsoft.DCP.CodeParser.license = "YOUR-LICENSE-KEY";

Specify the location of the "engine" files

This is usually only required with frameworks like Angular or React, etc. where dcp.js is compiled into another file.

The purpose is to tell the SDK where to find the engine files (*.worker.js, *.wasm.js and *.wasm, etc.). The API is called engineResourcePath :

//The following code uses the jsDelivr CDN, feel free to change it to your own location of these files
Dynamsoft.DCP.CodeParser.engineResourcePath = "https://cdn.jsdelivr.net/npm/dynamsoft-code-parser@1.1.0/dist/";

Interact with the SDK

Create a `CodeParser` object

To use the SDK, we first create a CodeParser object.

Dynamsoft.DCP.CodeParser.license = "YOUR-LICENSE-KEY";
let parser = null;
try {
    parser = await Dynamsoft.DCP.CodeParser.createInstance();
} catch (ex) {
    console.error(ex);
}

Tip: When creating a CodeParser object within a function which may be called more than once, it’s best to use a “helper” variable to avoid double creation such as pParser in the following code

Dynamsoft.DCP.CodeParser.license = "YOUR-LICENSE-KEY";
let pParser = null;

function foo() {
    try {
        const parser = await (pParser = pParser || Dynamsoft.DCP.CodeParser.createInstance());
    } catch (ex) {
        console.error(ex);
    }
}

Set code format

Before parsing, you need to specify the format of code to parse. See EnumCodeFormat to check if DCP-JS covers the code format you need.

parser.setCodeFormat(format); //format: EnumCodeFormat

Parse code

The method parseData() takes data in three formats: number[], Uint8Array and string. If you want to parse a barcode into readable info, you should first extract the information from the barcode using DBR-JS before parsing it with DCP-JS.

For more information on using DBR-JS, read DBR-JS User Guide.

parser.parseData(data); //data: number[] | Uint8Array | string

API Documentation

For more information about the APIs of DCP-JS, read Dynamsoft Code Parser JavaScript Edition API Reference.

HTML5 code parser JavaScript code parser Web code parser code parser SDK WebAssembly

cube-test-pkg @infinitebrahmanuniverse/nolb-shen @everything-registry/sub-chunk-2749

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

Dynamsoft Code Parser for Your Website

Hello World - Simplest Implementation

About the code

Building your own page

Include the SDK

Use a CDN

Host the SDK yourself

Configure the SDK

Specify the license

Specify the location of the "engine" files

Interact with the SDK

Create a CodeParser object

Set code format

Parse code

API Documentation

Create a `CodeParser` object