@twin.org/qr 0.0.1-next.5 → 0.0.1-next.51

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/docs/changelog.md +31 -1
  2. package/docs/reference/classes/JpegRenderer.md +8 -4
  3. package/docs/reference/classes/PngRenderer.md +8 -4
  4. package/docs/reference/classes/QR.md +15 -5
  5. package/docs/reference/classes/TextRenderer.md +6 -2
  6. package/package.json +5 -5
package/docs/changelog.md CHANGED
@@ -1,5 +1,35 @@
1
1
  # @twin.org/qr - Changelog
2
2
 
3
- ## 0.0.1-next.5
3
+ ## [0.0.1-next.51](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.50...qr-v0.0.1-next.51) (2025-03-27)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **qr:** Synchronize repo versions
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/core bumped from 0.0.1-next.50 to 0.0.1-next.51
16
+ * @twin.org/image bumped from 0.0.1-next.50 to 0.0.1-next.51
17
+
18
+ ## [0.0.1-next.50](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.49...qr-v0.0.1-next.50) (2025-03-26)
19
+
20
+
21
+ ### Miscellaneous Chores
22
+
23
+ * **qr:** Synchronize repo versions
24
+
25
+
26
+ ### Dependencies
27
+
28
+ * The following workspace dependencies were updated
29
+ * dependencies
30
+ * @twin.org/core bumped from 0.0.1-next.49 to 0.0.1-next.50
31
+ * @twin.org/image bumped from 0.0.1-next.49 to 0.0.1-next.50
32
+
33
+ ## 0.0.1-next.49
4
34
 
5
35
  - Initial Release
package/docs/reference/classes/JpegRenderer.md CHANGED
@@ -16,22 +16,26 @@ Class to render qr data as jpeg.
16
16
 
17
17
  ### render()
18
18
 
19
- > `static` **render**(`cellData`, `options`?): `Promise`\<`Uint8Array`\>
19
+ > `static` **render**(`cellData`, `options`?): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
20
20
 
21
21
  Render the QR code data as a bitmap.
22
22
 
23
23
  #### Parameters
24
24
 
25
- • **cellData**: [`QRCellData`](../type-aliases/QRCellData.md)
25
+ ##### cellData
26
+
27
+ [`QRCellData`](../type-aliases/QRCellData.md)
26
28
 
27
29
  The cell data for the QR code.
28
30
 
29
- • **options?**: [`IBitmapRendererOptions`](../interfaces/IBitmapRendererOptions.md)
31
+ ##### options?
32
+
33
+ [`IBitmapRendererOptions`](../interfaces/IBitmapRendererOptions.md)
30
34
 
31
35
  The options for rendering.
32
36
 
33
37
  #### Returns
34
38
 
35
- `Promise`\<`Uint8Array`\>
39
+ `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
36
40
 
37
41
  The bitmap content.
package/docs/reference/classes/PngRenderer.md CHANGED
@@ -16,22 +16,26 @@ Class to render qr data as png.
16
16
 
17
17
  ### render()
18
18
 
19
- > `static` **render**(`cellData`, `options`?): `Promise`\<`Uint8Array`\>
19
+ > `static` **render**(`cellData`, `options`?): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
20
20
 
21
21
  Render the QR code data as a bitmap.
22
22
 
23
23
  #### Parameters
24
24
 
25
- • **cellData**: [`QRCellData`](../type-aliases/QRCellData.md)
25
+ ##### cellData
26
+
27
+ [`QRCellData`](../type-aliases/QRCellData.md)
26
28
 
27
29
  The cell data for the QR code.
28
30
 
29
- • **options?**: [`IBitmapRendererOptions`](../interfaces/IBitmapRendererOptions.md)
31
+ ##### options?
32
+
33
+ [`IBitmapRendererOptions`](../interfaces/IBitmapRendererOptions.md)
30
34
 
31
35
  The options for rendering.
32
36
 
33
37
  #### Returns
34
38
 
35
- `Promise`\<`Uint8Array`\>
39
+ `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
36
40
 
37
41
  The bitmap content.
package/docs/reference/classes/QR.md CHANGED
@@ -13,11 +13,15 @@ Create a new instance of QR.
13
13
 
14
14
  #### Parameters
15
15
 
16
- • **typeNumber**: `number` = `6`
16
+ ##### typeNumber
17
+
18
+ `number` = `6`
17
19
 
18
20
  0 to 40, 0 means autodetect.
19
21
 
20
- • **errorCorrectLevel**: [`ErrorCorrectLevel`](../type-aliases/ErrorCorrectLevel.md) = `ErrorCorrectLevel.L`
22
+ ##### errorCorrectLevel
23
+
24
+ [`ErrorCorrectLevel`](../type-aliases/ErrorCorrectLevel.md) = `ErrorCorrectLevel.L`
21
25
 
22
26
  'L','M','Q','H'.
23
27
 
@@ -39,7 +43,9 @@ Add text data to the QR Code.
39
43
 
40
44
  #### Parameters
41
45
 
42
- • **qrData**: `string`
46
+ ##### qrData
47
+
48
+ `string`
43
49
 
44
50
  The data to add.
45
51
 
@@ -57,7 +63,9 @@ Add number to the QR Code.
57
63
 
58
64
  #### Parameters
59
65
 
60
- • **qrData**: `string`
66
+ ##### qrData
67
+
68
+ `string`
61
69
 
62
70
  The data to add.
63
71
 
@@ -75,7 +83,9 @@ Add alpha numeric to the QR Code.
75
83
 
76
84
  #### Parameters
77
85
 
78
- • **qrData**: `string`
86
+ ##### qrData
87
+
88
+ `string`
79
89
 
80
90
  The data to add.
81
91
 
package/docs/reference/classes/TextRenderer.md CHANGED
@@ -22,11 +22,15 @@ Render the QR code data as text.
22
22
 
23
23
  #### Parameters
24
24
 
25
- • **cellData**: [`QRCellData`](../type-aliases/QRCellData.md)
25
+ ##### cellData
26
+
27
+ [`QRCellData`](../type-aliases/QRCellData.md)
26
28
 
27
29
  The cell data for the QR code.
28
30
 
29
- • **options?**: [`ITextRendererOptions`](../interfaces/ITextRendererOptions.md)
31
+ ##### options?
32
+
33
+ [`ITextRendererOptions`](../interfaces/ITextRendererOptions.md)
30
34
 
31
35
  The options for rendering.
32
36
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/qr",
3
- "version": "0.0.1-next.5",
3
+ "version": "0.0.1-next.51",
4
4
  "description": "Package for creating QR codes",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,8 +14,8 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/core": "0.0.1-next.5",
18
- "@twin.org/image": "0.0.1-next.5",
17
+ "@twin.org/core": "0.0.1-next.51",
18
+ "@twin.org/image": "0.0.1-next.51",
19
19
  "@twin.org/nameof": "next"
20
20
  },
21
21
  "main": "./dist/cjs/index.cjs",
@@ -23,9 +23,9 @@
23
23
  "types": "./dist/types/index.d.ts",
24
24
  "exports": {
25
25
  ".": {
26
+ "types": "./dist/types/index.d.ts",
26
27
  "require": "./dist/cjs/index.cjs",
27
- "import": "./dist/esm/index.mjs",
28
- "types": "./dist/types/index.d.ts"
28
+ "import": "./dist/esm/index.mjs"
29
29
  }
30
30
  },
31
31
  "files": [