Skip to content

update to internal commit dfd1f36b #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 5, 2025
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
2 changes: 2 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ docFullPath: https://www.dynamsoft.com/code-parser/docs/web
firstLevelUrl: /code-parser/docs/web/
docRootName: "Code Parser JS Edition"
docHomePage: /code-parser/docs/core/introduction/
needSearchIndex: true
searchNeedFilter: true

js: /code-parser/docs/web/programming/javascript/
dcp_js_api: /code-parser/docs/web/programming/javascript/api-reference/
Expand Down
35 changes: 35 additions & 0 deletions programming/javascript/api-reference/enum-mapping-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
layout: default-layout
title: MappingStatus - Dynamsoft Code Parser Enumerations
description: The enumeration MappingStatus of Dynamsoft Code Parser represents the outcome of a mapping operation on a field.
keywords: Mapping status
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
breadcrumbText: MappingStatus
---

# Enumeration MappingStatus

`MappingStatus` represents the outcome of a mapping operation on a field.

<div class="sample-code-prefix template2"></div>
>- JavaScript
>
>
```javascript
enum EnumMappingStatus {
/**
* Indicates that no mapping operation has been initiated.
*/
MS_NONE = 0,
/**
* Indicates that the mapping operation was successfully completed.
*/
MS_SUCCEEDED = 1,
/**
* Indicates that the mapping operation failed to complete.
*/
MS_FAILED = 2
}
```
35 changes: 35 additions & 0 deletions programming/javascript/api-reference/enum-validation-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
layout: default-layout
title: ValidationStatus - Dynamsoft Code Parser Enumerations
description: The enumeration ValidationStatus of Dynamsoft Code Parser describes the outcome of a validation process on a field.
keywords: Validation status
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
breadcrumbText: ValidationStatus
---

# Enumeration ValidationStatus

`ValidationStatus` describes the outcome of a validation process on a field.

<div class="sample-code-prefix template2"></div>
>- JavaScript
>
>
```javascript
enum EnumValidationStatus {
/**
* Indicates that no validation has been performed.
*/
VS_NONE = 0,
/**
* Indicates that the validation process was completed successfully.
*/
VS_SUCCEEDED = 1,
/**
* Indicates that the validation process failed.
*/
VS_FAILED = 2
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
layout: default-layout
title: ParsedResult - Dynamsoft Code Parser JavaScript Interface
description: This page shows the ParsedResult interface of Dynamsoft Code Parser for JavaScript.
keywords: ParsedResult, javascript, interface
needAutoGenerateSidebar: false
noTitleIndex: true
breadcrumbText: ParsedResult
---

# ParsedResult

The ParsedResult interface provides a structure representing the result object returned by Dynamsoft Code Parser.

```ts
interface ParsedResult {
originalImageHashId: string;
originalImageTag: Core.ImageTag;
parsedResultItems: Array<ParsedResultItem>;
hasItem: (item: ParsedResultItem) => boolean;
removeItem: (item: ParsedResultItem) => void;
errorCode: number;
errorString: string;
}
```

<!-- | API Name | Description |
| ------------------------------------------- | ----------------------------------------------------------- |
| [originalImageHashId](#originalimagehashid) | Returns the hash id of the original image. |
| [originalImageTag](#originalimagetag) | Returns the tag of the original image. |
| [parsedResultItems](#parsedresultitems) | Returns an array that contains all `ParsedResultItem`s. |
| [hasItem()](#hasitem) | Checks whether the specified `ParsedResultItem` exists. |
| [removeItem()](#removeitem) | Removes the specified `ParsedResultItem`. |
| [errorCode](#errorcode) | Returns the error code for the parsing operation. |
| [errorString](#errorstring) | Returns the error string that corresponds with `errorCode`. | -->

## originalImageHashId

Returns the hash id of the original image.

```ts
originalImageHashId: string;
```

## originalImageTag

Returns the tag of the original image.

```ts
originalImageTag: Core.ImageTag;
```

**See Also**

* [ImageTag](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/image-tag.html)

## parsedResultItems

Returns an array that contains all `ParsedResultItem`s.

## hasItem()

Checks whether the specified `ParsedResultItem` exists.

## removeItem()

Removes the specified `ParsedResultItem`.

## errorCode

Returns the error code for the parsing operation.

## errorString

Returns the error string that corresponds with `errorCode`.
34 changes: 1 addition & 33 deletions programming/javascript/api-reference/interfaces/parsed-result.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,9 @@ The ParsedResult interface provides a structure representing the result object r

```ts
interface ParsedResult {
originalImageHashId: string;
originalImageTag: Core.ImageTag;
parsedResultItems: Array<ParsedResultItem>;
hasItem: (item: ParsedResultItem) => boolean;
removeItem: (item: ParsedResultItem) => void;
errorCode: number;
errorString: string;
}
```

Expand All @@ -34,26 +30,6 @@ interface ParsedResult {
| [errorCode](#errorcode) | Returns the error code for the parsing operation. |
| [errorString](#errorstring) | Returns the error string that corresponds with `errorCode`. | -->

## originalImageHashId

Returns the hash id of the original image.

```ts
originalImageHashId: string;
```

## originalImageTag

Returns the tag of the original image.

```ts
originalImageTag: Core.ImageTag;
```

**See Also**

* [ImageTag](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/image-tag.html)

## parsedResultItems

Returns an array that contains all `ParsedResultItem`s.
Expand All @@ -64,12 +40,4 @@ Checks whether the specified `ParsedResultItem` exists.

## removeItem()

Removes the specified `ParsedResultItem`.

## errorCode

Returns the error code for the parsing operation.

## errorString

Returns the error string that corresponds with `errorCode`.
Removes the specified `ParsedResultItem`.