docs: add example project section in README

- change prettier config line width - apply updated lint rule
Jaewoook · Dec 22, 2024 · 5e6d0c5 · 5e6d0c5
1 parent 71d3a4e
commit 5e6d0c5
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 4 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -4,7 +4,11 @@ module.exports = {
     es2021: true,
     node: true,
   },
-  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended",
+  ],
   overrides: [
     {
       env: {

diff --git a/.prettierrc b/.prettierrc
@@ -1,5 +1,5 @@
 {
-  "printWidth": 120,
+  "printWidth": 100,
   "singleQuote": false,
   "trailingComma": "es5",
   "semi": true

diff --git a/README.md b/README.md
@@ -33,6 +33,12 @@ yarn add pdfium.js
 npm install --save pdfium.js
 ```
 
+## Example project
+
+Check out this example project. The implemantion of renderer may helpful to achieve what you do.
+
+![example project](./images/example_project.png)
+
 ## Usage
 
 > [!NOTE]

diff --git a/images/example_project.png b/images/example_project.png
diff --git a/src/global.d.ts b/src/global.d.ts
@@ -39,7 +39,12 @@ export interface FPDF extends ModuleOptions {
   _FPDF_GetPageHeight: (pagePtr: number) => number;
   _FPDF_GetPageWidthF: (pagePtr: number) => number;
   _FPDF_GetPageHeightF: (pagePtr: number) => number;
-  _FPDF_GetPageSizeByIndex: (documentPtr: number, pageIndex: number, width: number, height: number) => number;
+  _FPDF_GetPageSizeByIndex: (
+    documentPtr: number,
+    pageIndex: number,
+    width: number,
+    height: number
+  ) => number;
   _FPDF_ClosePage: (pagePtr: number) => void;
   // Page Object
   _FPDFPage_CountObjects: (pagePtr: number) => number;
@@ -53,7 +58,13 @@ export interface FPDF extends ModuleOptions {
   _FPDFText_ClosePage: (textPagePtr: number) => void;
   // Bitmap
   _FPDFBitmap_Create: (width: number, height: number, alpha: number) => number;
-  _FPDFBitmap_CreateEx: (width: number, height: number, format: number, firstScan: number, stride: number) => number;
+  _FPDFBitmap_CreateEx: (
+    width: number,
+    height: number,
+    format: number,
+    firstScan: number,
+    stride: number
+  ) => number;
   _FPDFBitmap_FillRect: (
     bitmapPtr: number,
     left: number,