![](\"./img/cover.png\")
powerful image converter package, it can convert images into a different formats, it includes below features:
\r\n\r\n* [convert pdf to word document](#convert-pdf-to-word-document)\r\n* [convert images into a single pdf file](#convert-images-to-pdf)\r\n* [convert pdf to multiple image file](#convert-pdf-to-images)\r\n* [convert png to jpg](#convert-png-to-jpg)\r\n* [convert base64 to jpg or png](#base64-to-jpg-or-png)\r\n* [compress image files](#convert-png-to-jpg)\r\n* [add watermarks or extra effects to your image files](#add-effects)\r\n\r\nThen you can require or import as usual:
\r\n\r\n```javascript\r\nconst filepix = require(\"filepix\");\r\n```\r\n```typescript\r\nimport * as filepix from \"filepix\";\r\n```\r\nif you want to convert all images inside a specific directory you can use below code:\r\n
\r\npages: images directory path\r\n source: output for saving final PDF file\r\n
add easily a lot of effect to your images while converting to pdf\r\n
\r\nadd effect to your final pdf by set some options.\r\n\r\n#### Color\r\nApply multiple color modification rules\r\n\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'color',\r\n config: [{ apply: 'green', params: [100] }]\r\n }\r\n ]\r\n };\r\nfilepix.img2PDF(pages = './inputImagesDir', output = \"./outputImageDir/output.pdf\", options);\r\n```\r\n\r\n#### Flip\r\nFlip the image horizontally or vertically. Defaults to horizontal.\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'mirror'\r\n }\r\n ]\r\n };\r\n\r\n```\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'flip',\r\n config: {\r\n vertical: true\r\n }\r\n }\r\n ]\r\n };\r\nfilepix.img2PDF(pages = './inputImagesDir', output = \"./outputImageDir/output.pdf\", options);\r\n```\r\n#### Blur\r\nA fast blur algorithm that produces similar effect to a Gaussian blur\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'blur',\r\n config: {\r\n pixels: 50\r\n }\r\n }\r\n ]\r\n };\r\n```\r\n#### Rotate\r\nRotates the image clockwise by a number of degrees. By default the width and height of the image will be resized appropriately.\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'rotate',\r\n config: {\r\n ratio: 45\r\n }\r\n }\r\n ]\r\n};\r\n```\r\n#### Brightness\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'brightness',\r\n config: {\r\n ratio: 0.1\r\n }\r\n }\r\n ]\r\n};\r\n```\r\n#### Contrast\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'contrast',\r\n config: {\r\n ratio: 0.2\r\n }\r\n }\r\n ]\r\n };\r\n```\r\n#### Gaussian\r\n\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'gaussian',\r\n config: {\r\n ratio: 2\r\n }\r\n }\r\n ]\r\n};\r\n```\r\n\r\n#### Posterize\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'posterize',\r\n config: {\r\n ratio: 100\r\n }\r\n }\r\n ]\r\n};\r\n```\r\n#### Opacity\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'opacity',\r\n config: {\r\n ratio: 0.1\r\n }\r\n }\r\n ]\r\n};\r\n```\r\n### Sepia\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'sepia'\r\n }\r\n ]\r\n};\r\n```\r\n\r\n#### Quality\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'quality',\r\n config: {\r\n ratio: 10\r\n }\r\n }\r\n ]\r\n};\r\n```\r\n#### Fade\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'fade',\r\n config: {\r\n ratio: 0.1\r\n }\r\n }\r\n ]\r\n};\r\n```\r\n#### Pixelate\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'pixelate',\r\n config: {\r\n ratio: 50\r\n }\r\n }\r\n ]\r\n};\r\n```\r\n#### Normalize\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'normalize',\r\n config: {\r\n ratio: 50\r\n }\r\n }\r\n ]\r\n};\r\n```\r\n#### Threshold\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'threshold',\r\n config: { max: 200, replace: 200, autoGreyscale: false }\r\n }\r\n ]\r\n};\r\n```\r\n#### multiple effects\r\nyou can combine effects by using below code:\r\n```javascript\r\nlet options = {\r\n effects: [\r\n {\r\n name: 'quality',\r\n config: {\r\n ratio: 10\r\n }\r\n },\r\n {\r\n name: 'contrast',\r\n config: {\r\n ratio: 0.2\r\n }\r\n },\r\n {\r\n name: 'threshold',\r\n config: { max: 200 }\r\n }\r\n ]\r\n};\r\n```\r\n### Add watermarks\r\nyou can add watermark to all images and merge them as single pdf by set below option\r\npath: watermark image path\r\nposition: watermark position (center,right,right-bottom,center-bottom,left-top,left-bottom)\r\n\r\n```javascript\r\noptions = {\r\n watermark: {\r\n type: 'image',\r\n path: '../logo1.jpg',\r\n ratio: 0.2,\r\n opacity: 0.2,\r\n position: 'left-bottom'\r\n }\r\n}\r\n```\r\n\r\nPull requests are always welcome! Please base pull requests against the main branch and follow the contributing guide.\r\n\r\nif your pull requests makes documentation changes, please update readme file.\r\n
\r\n\r\n## License\r\n\r\nThis project is licensed under the terms of the\r\nMIT license\r\n","readmeFilename":"README.md","contributors":[{"name":"pariazar","email":"hamedpa19@gmail.com","url":"https://github.com/pariazar"}]}