Skip to content

Commit 93e83ea

Browse files
Ivan KamkinIvan Kamkin
authored andcommitted
Extend comments for JSDoc
Add not minified bundles
1 parent 48afd98 commit 93e83ea

3 files changed

Lines changed: 30 additions & 26 deletions

File tree

package.json

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,22 @@
124124
],
125125
"author": "Aspose.BarCode Team",
126126
"main": "dist/index.js",
127+
"module": "dist/index.mjs",
127128
"typings": "dist/index.d.ts",
129+
"exports": {
130+
".": {
131+
"types": "./dist/index.d.ts",
132+
"import": "./dist/index.mjs",
133+
"require": "./dist/index.js"
134+
},
135+
"./min": {
136+
"types": "./dist/index.d.ts",
137+
"import": "./dist/min/index.mjs",
138+
"require": "./dist/min/index.js"
139+
},
140+
"./dist/*": "./dist/*",
141+
"./package.json": "./package.json"
142+
},
128143
"files": [
129144
"dist"
130145
],
@@ -137,7 +152,9 @@
137152
"cover": "npx jest --coverage",
138153
"lint": "npx eslint src test snippets",
139154
"format": "npx eslint src test snippets eslint.config.mjs --fix",
140-
"prepare": "npx tsup",
155+
"build": "npx tsup",
156+
"build:min": "npx tsup --minify --outDir dist/min --no-dts",
157+
"prepare": "npm run build && npm run build:min",
141158
"check-updates": "ncu -u --enginesNode"
142159
},
143160
"prettier": {
@@ -154,7 +171,7 @@
154171
"splitting": false,
155172
"sourcemap": true,
156173
"clean": true,
157-
"minify": true
174+
"minify": false
158175
},
159176
"devDependencies": {
160177
"@types/jest": "^30.0.0",

src/api.ts

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -431,8 +431,7 @@ export class GenerateApi {
431431
}
432432

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

517516
/**
518-
*
519-
* @summary Generate barcode using POST request with parameters in body in json or xml format.
517+
* Generate barcode using POST request with parameters in body in json or xml format.
520518
* @param request GenerateBodyRequestWrapper
521519
*/
522520
public async generateBody(request: GenerateBodyRequestWrapper): Promise<{ response: ApiResponse; body: Buffer }> {
@@ -552,8 +550,7 @@ export class GenerateApi {
552550
}
553551

554552
/**
555-
*
556-
* @summary Generate barcode using POST request with parameters in multipart form.
553+
* Generate barcode using POST request with parameters in multipart form.
557554
* @param request GenerateMultipartRequestWrapper
558555
*/
559556
public async generateMultipart(
@@ -651,8 +648,7 @@ export class RecognizeApi {
651648
}
652649

653650
/**
654-
*
655-
* @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.
651+
* 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.
656652
* @param request RecognizeRequestWrapper
657653
*/
658654
public async recognize(
@@ -709,8 +705,7 @@ export class RecognizeApi {
709705
}
710706

711707
/**
712-
*
713-
* @summary Recognize barcode from file in request body using POST requests with parameters in body in json or xml format.
708+
* Recognize barcode from file in request body using POST requests with parameters in body in json or xml format.
714709
* @param request RecognizeBase64RequestWrapper
715710
*/
716711
public async recognizeBase64(
@@ -747,8 +742,7 @@ export class RecognizeApi {
747742
}
748743

749744
/**
750-
*
751-
* @summary Recognize barcode from file in request body using POST requests with parameters in multipart form.
745+
* Recognize barcode from file in request body using POST requests with parameters in multipart form.
752746
* @param request RecognizeMultipartRequestWrapper
753747
*/
754748
public async recognizeMultipart(
@@ -826,8 +820,7 @@ export class ScanApi {
826820
}
827821

828822
/**
829-
*
830-
* @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.
823+
* 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.
831824
* @param request ScanRequestWrapper
832825
*/
833826
public async scan(request: ScanRequestWrapper): Promise<{ response: ApiResponse; body: BarcodeResponseList }> {
@@ -862,8 +855,7 @@ export class ScanApi {
862855
}
863856

864857
/**
865-
*
866-
* @summary Scan barcode from file in request body using POST requests with parameter in body in json or xml format.
858+
* Scan barcode from file in request body using POST requests with parameter in body in json or xml format.
867859
* @param request ScanBase64RequestWrapper
868860
*/
869861
public async scanBase64(
@@ -900,8 +892,7 @@ export class ScanApi {
900892
}
901893

902894
/**
903-
*
904-
* @summary Scan barcode from file in request body using POST requests with parameter in multipart form.
895+
* Scan barcode from file in request body using POST requests with parameter in multipart form.
905896
* @param request ScanMultipartRequestWrapper
906897
*/
907898
public async scanMultipart(

src/models.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -687,7 +687,6 @@ Default value: 0.
687687

688688
/**
689689
* @param barcodeType Type of barcode to generate.
690-
691690
* @param data String represents data to encode
692691
*/
693692
constructor(barcodeType: EncodeBarcodeType, data: string) {
@@ -767,8 +766,7 @@ export class GenerateMultipartRequestWrapper {
767766
'rotationAngle'?: number;
768767

769768
/**
770-
* @param barcodeType
771-
769+
* @param barcodeType
772770
* @param data String represents data to encode
773771
*/
774772
constructor(barcodeType: EncodeBarcodeType, data: string) {
@@ -802,7 +800,6 @@ export class RecognizeRequestWrapper {
802800

803801
/**
804802
* @param barcodeType Type of barcode to recognize
805-
806803
* @param fileUrl Url to barcode image
807804
*/
808805
constructor(barcodeType: DecodeBarcodeType, fileUrl: string) {
@@ -850,8 +847,7 @@ export class RecognizeMultipartRequestWrapper {
850847
'recognitionImageKind'?: RecognitionImageKind;
851848

852849
/**
853-
* @param barcodeType
854-
850+
* @param barcodeType
855851
* @param fileBytes Barcode image file
856852
*/
857853
constructor(barcodeType: DecodeBarcodeType, fileBytes: Buffer) {

0 commit comments

Comments
 (0)