docs: update docs

schoero · Oct 28, 2023 · 0bc6527 · 0bc6527
1 parent 1dc7908
commit 0bc6527
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 39 deletions.
diff --git a/docs/pdf/index.md b/docs/pdf/index.md
@@ -67,7 +67,7 @@ Defined in: [src/pdf/swissqrbill.ts](../../src/pdf/swissqrbill.ts#L31C2)
 ###### Parameters
 
 - **data** [`Data`](./types.md#data) The data to be used for the QR Bill.  
-- **options** [`QRBillOptions`](./types.md#qrbilloptions) Options to define how the QR Bill should be rendered. `optional`  
+- **options** [`PDFOptions`](./types.md#pdfoptions) Options to define how the QR Bill should be rendered. `optional`  
 
 ##### Return Type
 
@@ -83,7 +83,7 @@ Creates a new SwissQRBill instance.
 
 `public` `static` `readonly`  
 
-Defined in: [src/pdf/swissqrbill.ts](../../src/pdf/swissqrbill.ts#L121C2)  
+Defined in: [src/pdf/swissqrbill.ts](../../src/pdf/swissqrbill.ts#L114C2)  
 
 ##### Type
 
@@ -97,7 +97,7 @@ The horizontal size of the QR Bill.
 
 `public` `static` `readonly`  
 
-Defined in: [src/pdf/swissqrbill.ts](../../src/pdf/swissqrbill.ts#L126C2)  
+Defined in: [src/pdf/swissqrbill.ts](../../src/pdf/swissqrbill.ts#L119C2)  
 
 ##### Type
 
@@ -115,7 +115,7 @@ The vertical size of the QR Bill.
 
 `public`  
 
-Defined in: [src/pdf/swissqrbill.ts](../../src/pdf/swissqrbill.ts#L76C2)  
+Defined in: [src/pdf/swissqrbill.ts](../../src/pdf/swissqrbill.ts#L69C2)  
 
 ##### Parameters
 
@@ -138,7 +138,7 @@ otherwise it will create a new page for the QR Bill.
 
 `public` `static`  
 
-Defined in: [src/pdf/swissqrbill.ts](../../src/pdf/swissqrbill.ts#L104C2)  
+Defined in: [src/pdf/swissqrbill.ts](../../src/pdf/swissqrbill.ts#L97C2)  
 
 ##### Parameters
 

diff --git a/docs/pdf/types.md b/docs/pdf/types.md
@@ -5,7 +5,8 @@
 
   - [Currency](#currency)
   - [Size](#size)
-  - [Languages](#languages)
+  - [Language](#language)
+  - [FontName](#fontname)
 
 - Interfaces
 
@@ -40,21 +41,31 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L3C0)
 
 ---
 
-### Languages
+### Language
 
 Defined in: [src/shared/types.ts](../../src/shared/types.ts#L4C0)  
 
 #### Type
 
 `"DE"` | `"EN"` | `"FR"` | `"IT"`  
 
+---
+
+### FontName
+
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L5C0)  
+
+#### Type
+
+`"Arial"` | `"Frutiger"` | `"Helvetica"` | `"Liberation Sans"`  
+
 ## Interfaces
 
 ---
 
 ### Data
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L6C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L7C0)  
 
 - **creditor** [`Creditor`](#creditor) Creditor related data.
 - **currency** [`Currency`](#currency) The currency to be used. **3 characters.**
@@ -76,7 +87,7 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L6C0)
 
 ### Debtor
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L65C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L66C0)  
 
 - **address** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Address. **Max 70 characters.**
 - **city** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) City. **Max 35 characters.**
@@ -89,7 +100,7 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L65C0)
 
 ### Creditor
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L98C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L99C0)  
 
 - **address** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Address. **Max 70 characters.**
 - **city** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) City. **Max 35 characters.**
@@ -103,33 +114,35 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L98C0)
 
 ### QRBillOptions
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L106C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L107C0)  
 
-- **font** `"Arial"` | `"Frutiger"` | `"Helvetica"` | `"Liberation Sans"` Font used for the QR-Bill.
+- **font** [`FontName`](#fontname) Font used for the QR-Bill.
   Fonts other than Helvetica must be registered in the PDFKit document.  [http://pdfkit.org/docs/text.html#fonts](http://pdfkit.org/docs/text.html#fonts) `optional`
-- **language** [`Languages`](#languages) The language with which the bill is rendered. `optional`
+- **language** [`Language`](#language) The language with which the bill is rendered. `optional`
 - **outlines** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want render the outlines. This option may be disabled if you use perforated paper. `optional`
 - **scissors** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the scissors icons or the text `Separate before paying in` `optional`
-- **separate** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the text `Separate before paying in` `optional`
 
 ---
 
 ### PDFOptions
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L144C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L137C0)  
 
-- **font** `"Arial"` | `"Frutiger"` | `"Helvetica"` | `"Liberation Sans"` Font used for the QR-Bill.
+- **font** [`FontName`](#fontname) Font used for the QR-Bill.
   Fonts other than Helvetica must be registered in the PDFKit document.  [http://pdfkit.org/docs/text.html#fonts](http://pdfkit.org/docs/text.html#fonts) `optional`
-- **language** [`Languages`](#languages) The language with which the bill is rendered. `optional`
+- **language** [`Language`](#language) The language with which the bill is rendered. `optional`
 - **outlines** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want render the outlines. This option may be disabled if you use perforated paper. `optional`
 - **scissors** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the scissors icons or the text `Separate before paying in` `optional`
 - **separate** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the text `Separate before paying in` `optional`
-- **autoGenerate** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to automatically finalize the PDF. When set to false you are able to add your own content to the PDF using PDFKit. `optional`
 
 ---
 
 ### SVGOptions
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L153C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L148C0)  
 
-- **language** [`Languages`](#languages) The language with which the bill is rendered. `optional`
+- **font** [`FontName`](#fontname) Font used for the QR-Bill.
+  Fonts other than Helvetica must be registered in the PDFKit document.  [http://pdfkit.org/docs/text.html#fonts](http://pdfkit.org/docs/text.html#fonts) `optional`
+- **language** [`Language`](#language) The language with which the bill is rendered. `optional`
+- **outlines** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want render the outlines. This option may be disabled if you use perforated paper. `optional`
+- **scissors** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the scissors icons or the text `Separate before paying in` `optional`
diff --git a/docs/svg/index.md b/docs/svg/index.md
@@ -40,7 +40,7 @@ Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L13C0)
 
 ##### constructor(data\[, options\])
 
-Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L20C2)  
+Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L24C2)  
 
 ###### Parameters
 
@@ -71,7 +71,7 @@ Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L15C2)
 
 `public`  
 
-Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L56C2)  
+Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L59C2)  
 
 ##### Return Type
 
@@ -89,7 +89,7 @@ Outputs the SVG as a string.
 
 `public`  
 
-Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L47C2)  
+Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L50C2)  
 
 ##### Return Type
 
@@ -101,7 +101,7 @@ Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L47C2)
 
 `public`  
 
-Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L66C2)  
+Defined in: [src/svg/swissqrbill.ts](../../src/svg/swissqrbill.ts#L69C2)  
 
 ##### Return Type
 

diff --git a/docs/svg/types.md b/docs/svg/types.md
@@ -5,7 +5,8 @@
 
   - [Currency](#currency)
   - [Size](#size)
-  - [Languages](#languages)
+  - [Language](#language)
+  - [FontName](#fontname)
 
 - Interfaces
 
@@ -40,21 +41,31 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L3C0)
 
 ---
 
-### Languages
+### Language
 
 Defined in: [src/shared/types.ts](../../src/shared/types.ts#L4C0)  
 
 #### Type
 
 `"DE"` | `"EN"` | `"FR"` | `"IT"`  
 
+---
+
+### FontName
+
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L5C0)  
+
+#### Type
+
+`"Arial"` | `"Frutiger"` | `"Helvetica"` | `"Liberation Sans"`  
+
 ## Interfaces
 
 ---
 
 ### Data
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L6C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L7C0)  
 
 - **creditor** [`Creditor`](#creditor) Creditor related data.
 - **currency** [`Currency`](#currency) The currency to be used. **3 characters.**
@@ -76,7 +87,7 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L6C0)
 
 ### Debtor
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L65C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L66C0)  
 
 - **address** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Address. **Max 70 characters.**
 - **city** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) City. **Max 35 characters.**
@@ -89,7 +100,7 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L65C0)
 
 ### Creditor
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L98C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L99C0)  
 
 - **address** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Address. **Max 70 characters.**
 - **city** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) City. **Max 35 characters.**
@@ -103,33 +114,35 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L98C0)
 
 ### QRBillOptions
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L106C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L107C0)  
 
-- **font** `"Arial"` | `"Frutiger"` | `"Helvetica"` | `"Liberation Sans"` Font used for the QR-Bill.
+- **font** [`FontName`](#fontname) Font used for the QR-Bill.
   Fonts other than Helvetica must be registered in the PDFKit document.  [http://pdfkit.org/docs/text.html#fonts](http://pdfkit.org/docs/text.html#fonts) `optional`
-- **language** [`Languages`](#languages) The language with which the bill is rendered. `optional`
+- **language** [`Language`](#language) The language with which the bill is rendered. `optional`
 - **outlines** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want render the outlines. This option may be disabled if you use perforated paper. `optional`
 - **scissors** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the scissors icons or the text `Separate before paying in` `optional`
-- **separate** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the text `Separate before paying in` `optional`
 
 ---
 
 ### PDFOptions
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L144C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L137C0)  
 
-- **font** `"Arial"` | `"Frutiger"` | `"Helvetica"` | `"Liberation Sans"` Font used for the QR-Bill.
+- **font** [`FontName`](#fontname) Font used for the QR-Bill.
   Fonts other than Helvetica must be registered in the PDFKit document.  [http://pdfkit.org/docs/text.html#fonts](http://pdfkit.org/docs/text.html#fonts) `optional`
-- **language** [`Languages`](#languages) The language with which the bill is rendered. `optional`
+- **language** [`Language`](#language) The language with which the bill is rendered. `optional`
 - **outlines** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want render the outlines. This option may be disabled if you use perforated paper. `optional`
 - **scissors** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the scissors icons or the text `Separate before paying in` `optional`
 - **separate** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the text `Separate before paying in` `optional`
-- **autoGenerate** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to automatically finalize the PDF. When set to false you are able to add your own content to the PDF using PDFKit. `optional`
 
 ---
 
 ### SVGOptions
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L153C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L148C0)  
 
-- **language** [`Languages`](#languages) The language with which the bill is rendered. `optional`
+- **font** [`FontName`](#fontname) Font used for the QR-Bill.
+  Fonts other than Helvetica must be registered in the PDFKit document.  [http://pdfkit.org/docs/text.html#fonts](http://pdfkit.org/docs/text.html#fonts) `optional`
+- **language** [`Language`](#language) The language with which the bill is rendered. `optional`
+- **outlines** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want render the outlines. This option may be disabled if you use perforated paper. `optional`
+- **scissors** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want to show the scissors icons or the text `Separate before paying in` `optional`