From 22a64a399016edc8ba382b767ee16b32b869fde8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roger=20Sch=C3=B6nb=C3=A4chler?= <42278642+schoero@users.noreply.github.com> Date: Tue, 7 Nov 2023 08:26:48 +0100 Subject: [PATCH] docs: update `unwritten` --- docs/bundle/index.md | 36 ++++++++++++++++++------------------ docs/pdf/index.md | 30 +++++++++++++++--------------- docs/svg/index.md | 6 +++--- package-lock.json | 8 ++++---- package.json | 2 +- 5 files changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/bundle/index.md b/docs/bundle/index.md index 72be1c4..d8b8e02 100644 --- a/docs/bundle/index.md +++ b/docs/bundle/index.md @@ -17,15 +17,15 @@ - [width](#property-pdfswissqrbillwidth) - [height](#property-pdfswissqrbillheight) - Methods - - [attachTo(doc, x, y)](#method-pdfswissqrbillattachtodoc-x-y) + - [attachTo(doc\[, x\]\[, y\])](#method-pdfswissqrbillattachtodoc-x-y) - [isSpaceSufficient(doc, xPosition, yPosition)](#method-pdfswissqrbillisspacesufficientdoc-xposition-yposition) - [SwissQRCode](#class-pdfswissqrcode) - Constructor - - [new SwissQRCode(data, size)](#constructor-new-pdfswissqrcodedata-size) + - [new SwissQRCode(data\[, size\])](#constructor-new-pdfswissqrcodedata-size) - Method - - [attachTo(doc, x, y)](#method-pdfswissqrcodeattachtodoc-x-y) + - [attachTo(doc\[, x\]\[, y\])](#method-pdfswissqrcodeattachtodoc-x-y) - [PDFTable](#interface-pdfpdftable) - [PDFRow](#interface-pdfpdfrow) @@ -35,7 +35,7 @@ - Constructor - [new Table(data)](#constructor-new-pdftabledata) - Method - - [attachTo(doc, x, y)](#method-pdftableattachtodoc-x-y) + - [attachTo(doc\[, x\]\[, y\])](#method-pdftableattachtodoc-x-y) - [svg](#namespace-svg) @@ -56,7 +56,7 @@ - [SwissQRCode](#class-svgswissqrcode) - Constructor - - [new SwissQRCode(data, size)](#constructor-new-svgswissqrcodedata-size) + - [new SwissQRCode(data\[, size\])](#constructor-new-svgswissqrcodedata-size) - [types](#namespace-types) @@ -180,7 +180,7 @@ The vertical size of the QR Bill.
-##### Method: pdf.SwissQRBill.attachTo(doc, x, y) +##### Method: pdf.SwissQRBill.attachTo(doc\[, x\]\[, y\]) `public` @@ -189,8 +189,8 @@ Defined in: [src/pdf/swissqrbill.ts](../../src/pdf/swissqrbill.ts#L69C2) ###### Parameters - **doc** `PDFDocument` The PDFKit instance -- **x** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The horizontal position in points where the QR Bill will be placed. Default: `0` -- **y** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The vertical position in points where the QR Bill will be placed. Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) +- **x** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The horizontal position in points where the QR Bill will be placed. `optional` Default: `0` +- **y** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The vertical position in points where the QR Bill will be placed. `optional` Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) ###### Return Type @@ -231,14 +231,14 @@ Defined in: [src/pdf/swissqrcode.ts](../../src/pdf/swissqrcode.ts#L7C0)
-##### Constructor: new pdf.SwissQRCode(data, size) +##### Constructor: new pdf.SwissQRCode(data\[, size\]) Defined in: [src/pdf/swissqrcode.ts](../../src/pdf/swissqrcode.ts#L17C2) ###### Parameters - **data** [`Data`](#interface-typesdata) The data to be encoded in the QR code. -- **size** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The size of the QR code in mm. Default: `46` +- **size** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The size of the QR code in mm. `optional` Default: `46` ###### Return Type @@ -250,7 +250,7 @@ Creates a Swiss QR Code.
-##### Method: pdf.SwissQRCode.attachTo(doc, x, y) +##### Method: pdf.SwissQRCode.attachTo(doc\[, x\]\[, y\]) `public` @@ -259,8 +259,8 @@ Defined in: [src/pdf/swissqrcode.ts](../../src/pdf/swissqrcode.ts#L29C2) ###### Parameters - **doc** `PDFDocument` The PDF document to attach the Swiss QR Code to. -- **x** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The horizontal position in points where the Swiss QR Code will be placed. Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) -- **y** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The vertical position in points where the Swiss QR Code will be placed. Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) +- **x** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The horizontal position in points where the Swiss QR Code will be placed. `optional` Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) +- **y** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The vertical position in points where the Swiss QR Code will be placed. `optional` Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) ###### Return Type @@ -474,7 +474,7 @@ const table = {
-##### Method: pdf.Table.attachTo(doc, x, y) +##### Method: pdf.Table.attachTo(doc\[, x\]\[, y\]) `public` @@ -483,8 +483,8 @@ Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L156C2) ###### Parameters - **doc** `PDFDocument` The PDFKit document instance -- **x** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The horizontal position in points where the table be placed. Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) -- **y** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The vertical position in points where the table will be placed. Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) +- **x** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The horizontal position in points where the table be placed. `optional` Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) +- **y** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The vertical position in points where the table will be placed. `optional` Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) ###### Return Type @@ -589,14 +589,14 @@ Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L8C0)
-##### Constructor: new svg.SwissQRCode(data, size) +##### Constructor: new svg.SwissQRCode(data\[, size\]) Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L15C2) ###### Parameters - **data** [`Data`](#interface-typesdata) The data to be encoded in the QR code. -- **size** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The size of the QR code in mm. Default: `46` +- **size** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The size of the QR code in mm. `optional` Default: `46` ###### Return Type diff --git a/docs/pdf/index.md b/docs/pdf/index.md index 00937b3..fb90829 100644 --- a/docs/pdf/index.md +++ b/docs/pdf/index.md @@ -13,22 +13,22 @@ - [width](#property-swissqrbillwidth) - [height](#property-swissqrbillheight) - Methods - - [attachTo(doc, x, y)](#method-swissqrbillattachtodoc-x-y) + - [attachTo(doc\[, x\]\[, y\])](#method-swissqrbillattachtodoc-x-y) - [isSpaceSufficient(doc, xPosition, yPosition)](#method-swissqrbillisspacesufficientdoc-xposition-yposition) - [SwissQRCode](#class-swissqrcode) - Constructor - - [new SwissQRCode(data, size)](#constructor-new-swissqrcodedata-size) + - [new SwissQRCode(data\[, size\])](#constructor-new-swissqrcodedata-size) - Method - - [attachTo(doc, x, y)](#method-swissqrcodeattachtodoc-x-y) + - [attachTo(doc\[, x\]\[, y\])](#method-swissqrcodeattachtodoc-x-y) - [Table](#class-table) - Constructor - [new Table(data)](#constructor-new-tabledata) - Method - - [attachTo(doc, x, y)](#method-tableattachtodoc-x-y) + - [attachTo(doc\[, x\]\[, y\])](#method-tableattachtodoc-x-y) - [PDFTable](#interface-pdftable) - [PDFRow](#interface-pdfrow) @@ -100,7 +100,7 @@ The vertical size of the QR Bill.
-#### Method: SwissQRBill.attachTo(doc, x, y) +#### Method: SwissQRBill.attachTo(doc\[, x\]\[, y\]) `public` @@ -109,8 +109,8 @@ Defined in: [src/pdf/swissqrbill.ts](../../src/pdf/swissqrbill.ts#L69C2) ##### Parameters - **doc** `PDFDocument` The PDFKit instance -- **x** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The horizontal position in points where the QR Bill will be placed. Default: `0` -- **y** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The vertical position in points where the QR Bill will be placed. Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) +- **x** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The horizontal position in points where the QR Bill will be placed. `optional` Default: `0` +- **y** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The vertical position in points where the QR Bill will be placed. `optional` Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) ##### Return Type @@ -151,14 +151,14 @@ Defined in: [src/pdf/swissqrcode.ts](../../src/pdf/swissqrcode.ts#L7C0)
-#### Constructor: new SwissQRCode(data, size) +#### Constructor: new SwissQRCode(data\[, size\]) Defined in: [src/pdf/swissqrcode.ts](../../src/pdf/swissqrcode.ts#L17C2) ##### Parameters - **data** [`Data`](./types.md#interface-data) The data to be encoded in the QR code. -- **size** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The size of the QR code in mm. Default: `46` +- **size** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The size of the QR code in mm. `optional` Default: `46` ##### Return Type @@ -170,7 +170,7 @@ Creates a Swiss QR Code.
-#### Method: SwissQRCode.attachTo(doc, x, y) +#### Method: SwissQRCode.attachTo(doc\[, x\]\[, y\]) `public` @@ -179,8 +179,8 @@ Defined in: [src/pdf/swissqrcode.ts](../../src/pdf/swissqrcode.ts#L29C2) ##### Parameters - **doc** `PDFDocument` The PDF document to attach the Swiss QR Code to. -- **x** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The horizontal position in points where the Swiss QR Code will be placed. Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) -- **y** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The vertical position in points where the Swiss QR Code will be placed. Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) +- **x** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The horizontal position in points where the Swiss QR Code will be placed. `optional` Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) +- **y** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The vertical position in points where the Swiss QR Code will be placed. `optional` Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) ##### Return Type @@ -247,7 +247,7 @@ const table = {
-#### Method: Table.attachTo(doc, x, y) +#### Method: Table.attachTo(doc\[, x\]\[, y\]) `public` @@ -256,8 +256,8 @@ Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L156C2) ##### Parameters - **doc** `PDFDocument` The PDFKit document instance -- **x** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The horizontal position in points where the table be placed. Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) -- **y** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The vertical position in points where the table will be placed. Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) +- **x** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The horizontal position in points where the table be placed. `optional` Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) +- **y** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The vertical position in points where the table will be placed. `optional` Default: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) ##### Return Type diff --git a/docs/svg/index.md b/docs/svg/index.md index 4d878e4..ccc074d 100644 --- a/docs/svg/index.md +++ b/docs/svg/index.md @@ -20,7 +20,7 @@ - [SwissQRCode](#class-swissqrcode) - Constructor - - [new SwissQRCode(data, size)](#constructor-new-swissqrcodedata-size) + - [new SwissQRCode(data\[, size\])](#constructor-new-swissqrcodedata-size)
@@ -109,14 +109,14 @@ Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L8C0)
-#### Constructor: new SwissQRCode(data, size) +#### Constructor: new SwissQRCode(data\[, size\]) Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L15C2) ##### Parameters - **data** [`Data`](./types.md#interface-data) The data to be encoded in the QR code. -- **size** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The size of the QR code in mm. Default: `46` +- **size** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) The size of the QR code in mm. `optional` Default: `46` ##### Return Type diff --git a/package-lock.json b/package-lock.json index b101ffa..0955f5b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -30,7 +30,7 @@ "glob": "^10.3.10", "pdfkit": "^0.13.0", "typescript": "^5.2.2", - "unwritten": "^0.2.1", + "unwritten": "^0.2.2", "vite-plugin-dts": "^3.6.3", "vite-plugin-no-bundle": "^3.0.0", "vitest": "^0.34.6" @@ -8304,9 +8304,9 @@ } }, "node_modules/unwritten": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/unwritten/-/unwritten-0.2.1.tgz", - "integrity": "sha512-BBo4Nk4kGlGGqPDzkv4C5OrhyTbvBUCkg67j7NWdBEvDrXRCy4+E9DJ9EkmJ5E14DMLxh89VquMSCzHoK12tAg==", + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/unwritten/-/unwritten-0.2.2.tgz", + "integrity": "sha512-H2x9G/N0rpzzPSp3NE3aMIDl4Ev0aOM+6a44Qczc7BZl7H3g4hoWFS4YeCd7O85oaOPrjx1K+gDSsd/hA9405g==", "dev": true, "dependencies": { "cac": "^6.7.14", diff --git a/package.json b/package.json index f4d3269..fd66492 100644 --- a/package.json +++ b/package.json @@ -116,7 +116,7 @@ "glob": "^10.3.10", "pdfkit": "^0.13.0", "typescript": "^5.2.2", - "unwritten": "^0.2.1", + "unwritten": "^0.2.2", "vite-plugin-dts": "^3.6.3", "vite-plugin-no-bundle": "^3.0.0", "vitest": "^0.34.6"