Skip to content

Commit

Permalink
docs: update unwritten
Browse files Browse the repository at this point in the history
  • Loading branch information
@schoero
schoero committed Nov 7, 2023
1 parent 684f0bf commit 22a64a3
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 41 deletions.
36 changes: 18 additions & 18 deletions docs/bundle/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)

Expand All @@ -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)

Expand Down Expand Up @@ -180,7 +180,7 @@ The vertical size of the QR Bill.

<br/>

##### Method: pdf.SwissQRBill.attachTo(doc, x, y)
##### Method: pdf.SwissQRBill.attachTo(doc\[, x\]\[, y\])

`public`

Expand All @@ -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

Expand Down Expand Up @@ -231,14 +231,14 @@ Defined in: [src/pdf/swissqrcode.ts](../../src/pdf/swissqrcode.ts#L7C0)

<br/>

##### 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

Expand All @@ -250,7 +250,7 @@ Creates a Swiss QR Code.

<br/>

##### Method: pdf.SwissQRCode.attachTo(doc, x, y)
##### Method: pdf.SwissQRCode.attachTo(doc\[, x\]\[, y\])

`public`

Expand All @@ -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

Expand Down Expand Up @@ -474,7 +474,7 @@ const table = {

<br/>

##### Method: pdf.Table.attachTo(doc, x, y)
##### Method: pdf.Table.attachTo(doc\[, x\]\[, y\])

`public`

Expand All @@ -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

Expand Down Expand Up @@ -589,14 +589,14 @@ Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L8C0)

<br/>

##### 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

Expand Down
30 changes: 15 additions & 15 deletions docs/pdf/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -100,7 +100,7 @@ The vertical size of the QR Bill.

<br/>

#### Method: SwissQRBill.attachTo(doc, x, y)
#### Method: SwissQRBill.attachTo(doc\[, x\]\[, y\])

`public`

Expand All @@ -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

Expand Down Expand Up @@ -151,14 +151,14 @@ Defined in: [src/pdf/swissqrcode.ts](../../src/pdf/swissqrcode.ts#L7C0)

<br/>

#### 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

Expand All @@ -170,7 +170,7 @@ Creates a Swiss QR Code.

<br/>

#### Method: SwissQRCode.attachTo(doc, x, y)
#### Method: SwissQRCode.attachTo(doc\[, x\]\[, y\])

`public`

Expand All @@ -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

Expand Down Expand Up @@ -247,7 +247,7 @@ const table = {

<br/>

#### Method: Table.attachTo(doc, x, y)
#### Method: Table.attachTo(doc\[, x\]\[, y\])

`public`

Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/svg/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
- [SwissQRCode](#class-swissqrcode)

- Constructor
- [new SwissQRCode(data, size)](#constructor-new-swissqrcodedata-size)
- [new SwissQRCode(data\[, size\])](#constructor-new-swissqrcodedata-size)

<br/>

Expand Down Expand Up @@ -109,14 +109,14 @@ Defined in: [src/svg/swissqrcode.ts](../../src/svg/swissqrcode.ts#L8C0)

<br/>

#### 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

Expand Down
8 changes: 4 additions & 4 deletions package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 22a64a3

Please sign in to comment.