CodeParserModule Class

The CodeParserModule class is defined in the namespace Dynamsoft.DCP.

getVersion

Returns the version of the CodeParser module.

static getVersion(): string;

Code snippet

const version = Dynamsoft.DCP.CodeParserModule.getVersion();
console.log(version);

loadSpec

Loads the specification for a certain type of code strings.

loadSpec(specificationName: string | Array<string>, specificationPath?: string): Promise<void>;

Parameters

• specificationName: specifies the name of the specification.
• specificationPath: specifies the path to find the specification file. If not specified, the method will try to load the file from the path specified for the “dcp” module in Dynamsoft.Core.CoreModule.engineResourcePaths. For example, if the path for the “dcp” module is “https://cdn.jsdelivr.net/npm/dynamsoft-code-parser@2.0.20/dist/”, then calling Dynamsoft.DCP.CodeParserModule.loadSpec("AADHAAR") will load the file “AADHAAR.data” from “https://cdn.jsdelivr.net/npm/dynamsoft-code-parser@2.0.20/dist/specification/AADHAAR.data”.

Code Snippet

await Dynamsoft.DCP.CodeParserModule.loadSpec("AADHAAR");

onSpecLoadProgressChanged

An event that fires during the loading of specification files.

Syntax

static onSpecLoadProgressChanged (filePath: string, tag: "starting"| "in progress" | "completed", progress: { loaded: number, total: number }) : void;

Parameter

filePath : The path of the specification files.

tag(Optional) : Indicates the ongoing status of the file download (“starting”, “in progress”, “completed”).

progress : An object indicating the progress of the download, with loaded and total bytes.

Return value

None.

Code snippet

Dynamsoft.DCP.CodeParserModule.onSpecLoadProgressChanged = function(filePath, tag, progress) {
    console.log(`Status: ${tag} - File: ${filePath}`);
    if (tag === "in progress") {
        let percent = ((progress.loaded / progress.total) * 100).toFixed(1);
        console.log(`Progress: ${percent}%`);
    } else if (tag === "completed") {
        console.log("specification files loading completed!");
    }
};

Remarks

Introduced in Dynamsoft Barcode Reader Bundle version 11.2.2000 and Dynamsoft Capture Vision Bundle version 3.2.1000.