Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ dnt_icon: /code-parser/docs/web/assets/img-icon/icon-dnt.svg
release_notes: /code-parser/docs/core/release-notes/
code_types: /code-parser/docs/core/code-types/

useVersionTree: true
useVersionTree: false
isDCV: true

baseurl: "/code-parser/docs/web"
plugins:
Expand Down
File renamed without changes.
File renamed without changes.
150 changes: 150 additions & 0 deletions programming/javascript/api-reference/code-parser-v2.2.10.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
---
layout: default-layout
title: CodeParser Class - Dynamsoft Code Parser SDK JS Edition API Reference
description: This page shows CodeParser Class of Dynamsoft Code Parser SDK JS Edition.
keywords: CodeParser, api reference, JS, JavaScript
needAutoGenerateSidebar: true
---

# CodeParser Class

The `CodeParser` class enable users to parse given bytes or a string to be human-readable.

| Method | Description |
| -------------------------------------------- | ---------------------------------------------------------------------- |
| `static` [createInstance()](#createinstance) | Initializes a new instance of the `CodeParser` class. |
| [dispose()](#dispose) | Releases all resources used by the `CodeParser` object. |
| [disposed](#disposed) | Returns whether the `CodeParser` object has been disposed of. |
| [initSettings](#initsettings) | Initializes runtime settings with the settings in a given JSON string. |
| [resetSettings](#resetsettings) | Resets runtime settings to default. |
| [parse](#parse) | Parses code data for readable results. |

## createInstance

Initializes a new instance of the `CodeParser` class.

**Syntax**

```typescript
createInstance(): Promise<CodeParser>;
```

**Parameter**

None.

**Return value**

A promise that resolves to the initialized `CodeParser` object.

**Code snippet**

```javascript
let parser = await Dynamsoft.DCP.CodeParser.createInstance();
```

## dispose

Releases all resources used by the `CodeParser` object.

**Syntax**

```typescript
dispose(): Promise<void>;
```

**Parameter**

None.

**Return value**

Returns a promise that resolves when the resources have been successfully released.

**Code snippet**

```javascript
let parser = await Dynamsoft.DCP.CodeParser.createInstance();
// Use the parser to perform a job.
// ...
// Release the resources after the job is finished.
parser.dispose();
```

## disposed

Returns whether the `CodeParser` object has been disposed of.

**Syntax**

```typescript
disposed: boolean;
```

**Parameter**

None.

**Return value**

A boolean value that indicates whether the `CodeParser` object has been disposed of.

**Code snippet**

```javascript
if(parser.disposed){
console.log("The parser has been disposed of.");
} else {
// Use the parser to perform a job.
}
```

## initSettings

Initializes settings from a given string.

```typescript
initSettings: (settings: string) => Promise<void>;
```

**Parameters**

* `settings`: A JSON string that represents the content of the settings.

**Return value**

A promise that resolves when the operation has completed. It does not provide any value upon resolution.

## resetSettings

Resets all parameters to default values.

```typescript
resetSettings: () => Promise<void>;
```

**Parameters**

None.

**Return value**

Returns a promise that resolves when the settings have been successfully reset to their default values.

## parse

Parses a single string to be human-readable.

```typescript
parse: (source: Uint8Array | string, taskSettingName?: string) => Promise<ParsedResultItem>;
```

**Parameters**

* `source`: the array of bytes or the string to parse.

* `taskSettingName`: the name of [CodeParserTaskSetting](https://www.dynamsoft.com/capture-vision/docs/core/parameters/reference/code-parser-task-settings/) that defines the settings used for code parsing.

**Return Value**

Returns an array of [ParsedResultItem](./interfaces/parsed-result-item.md) containing the human-readable results.
2 changes: 1 addition & 1 deletion programming/javascript/api-reference/code-parser.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Returns a promise that resolves when the settings have been successfully reset t
Parses a single string to be human-readable.

```typescript
parse: (source: Uint8Array | string, taskSettingName?: string) => Promise<ParsedResultItem>;
parse: (source: Uint8Array | string | Array<number>, taskSettingName?: string) => Promise<ParsedResultItem>;
```

**Parameters**
Expand Down
Loading