Skip to content

Add jsdoc #121

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.

Sign up for GitHub

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
ivankamkin merged 2 commits into from
Feb 12, 2026
Merged

Add jsdoc #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93e83ea
Extend comments for JSDoc
Feb 5, 2026
037c705
Update build steps
ivankamkin Feb 9, 2026
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
18 changes: 15 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,17 @@
],
"author": "Aspose.BarCode Team",
"main": "dist/index.js",
"module": "dist/index.mjs",
"typings": "dist/index.d.ts",
"exports": {
".": {
"types": "./dist/index.d.ts",
"import": "./dist/index.mjs",
"require": "./dist/index.js"
},
"./dist/*": "./dist/*",
"./package.json": "./package.json"
},
"files": [
"dist"
],
Expand All @@ -137,7 +147,9 @@
"cover": "npx jest --coverage",
"lint": "npx eslint src test snippets",
"format": "npx eslint src test snippets eslint.config.mjs --fix",
"prepare": "npx tsup",
"build": "npx tsup",
"build:min": "npx tsup --minify --outDir dist/min --no-dts",
"prepare": "npm run build",
"check-updates": "ncu -u --enginesNode"
},
"prettier": {
Expand All @@ -152,9 +164,9 @@
"format": ["cjs", "esm"],
"dts": true,
"splitting": false,
"sourcemap": true,
"sourcemap": false,
"clean": true,
"minify": true
"minify": false
},
"devDependencies": {
"@types/jest": "^30.0.0",
Expand Down
5 changes: 0 additions & 5 deletions scripts/run_example.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@

set -euo pipefail

if [[ "${ASPOSE_E2E:-}" != "1" ]]; then
echo "Skipping example: set ASPOSE_E2E=1 to run against live API."
exit 0
fi

TEST_DIR="demo"

rm -rf "${TEST_DIR}" || true
Expand Down
27 changes: 9 additions & 18 deletions src/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,8 +431,7 @@ export class GenerateApi {
}

/**
*
* @summary Generate barcode using GET request with parameters in route and query string.
* Generate barcode using GET request with parameters in route and query string.
* @param request GenerateRequestWrapper
*/
public async generate(request: GenerateRequestWrapper): Promise<{ response: ApiResponse; body: Buffer }> {
Expand Down Expand Up @@ -515,8 +514,7 @@ export class GenerateApi {
}

/**
*
* @summary Generate barcode using POST request with parameters in body in json or xml format.
* Generate barcode using POST request with parameters in body in json or xml format.
* @param request GenerateBodyRequestWrapper
*/
public async generateBody(request: GenerateBodyRequestWrapper): Promise<{ response: ApiResponse; body: Buffer }> {
Expand Down Expand Up @@ -552,8 +550,7 @@ export class GenerateApi {
}

/**
*
* @summary Generate barcode using POST request with parameters in multipart form.
* Generate barcode using POST request with parameters in multipart form.
* @param request GenerateMultipartRequestWrapper
*/
public async generateMultipart(
Expand Down Expand Up @@ -651,8 +648,7 @@ export class RecognizeApi {
}

/**
*
* @summary Recognize barcode from file on server in the Internet using GET requests with parameter in query string. For recognizing files from your hard drive use `recognize-body` or `recognize-multipart` endpoints instead.
* Recognize barcode from file on server in the Internet using GET requests with parameter in query string. For recognizing files from your hard drive use `recognize-body` or `recognize-multipart` endpoints instead.
* @param request RecognizeRequestWrapper
*/
public async recognize(
Expand Down Expand Up @@ -709,8 +705,7 @@ export class RecognizeApi {
}

/**
*
* @summary Recognize barcode from file in request body using POST requests with parameters in body in json or xml format.
* Recognize barcode from file in request body using POST requests with parameters in body in json or xml format.
* @param request RecognizeBase64RequestWrapper
*/
public async recognizeBase64(
Expand Down Expand Up @@ -747,8 +742,7 @@ export class RecognizeApi {
}

/**
*
* @summary Recognize barcode from file in request body using POST requests with parameters in multipart form.
* Recognize barcode from file in request body using POST requests with parameters in multipart form.
* @param request RecognizeMultipartRequestWrapper
*/
public async recognizeMultipart(
Expand Down Expand Up @@ -826,8 +820,7 @@ export class ScanApi {
}

/**
*
* @summary Scan barcode from file on server in the Internet using GET requests with parameter in query string. For scaning files from your hard drive use `scan-body` or `scan-multipart` endpoints instead.
* Scan barcode from file on server in the Internet using GET requests with parameter in query string. For scaning files from your hard drive use `scan-body` or `scan-multipart` endpoints instead.
* @param request ScanRequestWrapper
*/
public async scan(request: ScanRequestWrapper): Promise<{ response: ApiResponse; body: BarcodeResponseList }> {
Expand Down Expand Up @@ -862,8 +855,7 @@ export class ScanApi {
}

/**
*
* @summary Scan barcode from file in request body using POST requests with parameter in body in json or xml format.
* Scan barcode from file in request body using POST requests with parameter in body in json or xml format.
* @param request ScanBase64RequestWrapper
*/
public async scanBase64(
Expand Down Expand Up @@ -900,8 +892,7 @@ export class ScanApi {
}

/**
*
* @summary Scan barcode from file in request body using POST requests with parameter in multipart form.
* Scan barcode from file in request body using POST requests with parameter in multipart form.
* @param request ScanMultipartRequestWrapper
*/
public async scanMultipart(
Expand Down
8 changes: 2 additions & 6 deletions src/models.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -687,7 +687,6 @@ Default value: 0.

/**
* @param barcodeType Type of barcode to generate.

* @param data String represents data to encode
*/
constructor(barcodeType: EncodeBarcodeType, data: string) {
Expand Down Expand Up @@ -767,8 +766,7 @@ export class GenerateMultipartRequestWrapper {
'rotationAngle'?: number;

/**
* @param barcodeType

* @param barcodeType
* @param data String represents data to encode
*/
constructor(barcodeType: EncodeBarcodeType, data: string) {
Expand Down Expand Up @@ -802,7 +800,6 @@ export class RecognizeRequestWrapper {

/**
* @param barcodeType Type of barcode to recognize

* @param fileUrl Url to barcode image
*/
constructor(barcodeType: DecodeBarcodeType, fileUrl: string) {
Expand Down Expand Up @@ -850,8 +847,7 @@ export class RecognizeMultipartRequestWrapper {
'recognitionImageKind'?: RecognitionImageKind;

/**
* @param barcodeType

* @param barcodeType
* @param fileBytes Barcode image file
*/
constructor(barcodeType: DecodeBarcodeType, fileBytes: Buffer) {
Expand Down
2 changes: 1 addition & 1 deletion tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"lib": ["es6"],
"importHelpers": true,
"declaration": true,
"sourceMap": true,
"sourceMap": false,
"rootDir": "./src",
"strict": true,
"moduleResolution": "node",
Expand Down
Loading