{"id":13998550,"url":"https://github.com/node-escpos/driver","last_synced_at":"2025-07-23T06:32:05.898Z","repository":{"id":61913858,"uuid":"556200956","full_name":"node-escpos/driver","owner":"node-escpos","description":"🖨️ ESC/POS Printer driver for Node.js.","archived":false,"fork":false,"pushed_at":"2024-07-04T16:10:22.000Z","size":19822,"stargazers_count":319,"open_issues_count":29,"forks_count":32,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-11-29T12:45:00.224Z","etag":null,"topics":["bluetooth","driver","escpos","escpos-printer","hacktoberfest","hardware","network","node-escpos","node-printer","nodejs","printer","serialport","thermal-printing","usb"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/node-escpos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["dohooo"]}},"created_at":"2022-10-23T09:49:46.000Z","updated_at":"2024-11-28T15:44:31.000Z","dependencies_parsed_at":"2024-10-21T20:06:16.737Z","dependency_job_id":null,"html_url":"https://github.com/node-escpos/driver","commit_stats":{"total_commits":103,"total_committers":9,"mean_commits":"11.444444444444445","dds":0.5145631067961165,"last_synced_commit":"3861181e3a9a11bb071c3cc01c0dda666c7bcbf8"},"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/node-escpos%2Fdriver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/node-escpos%2Fdriver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/node-escpos%2Fdriver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/node-escpos%2Fdriver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/node-escpos","download_url":"https://codeload.github.com/node-escpos/driver/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227245185,"owners_count":17753239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bluetooth","driver","escpos","escpos-printer","hacktoberfest","hardware","network","node-escpos","node-printer","nodejs","printer","serialport","thermal-printing","usb"],"created_at":"2024-08-09T19:01:46.339Z","updated_at":"2024-11-30T00:31:42.738Z","avatar_url":"https://github.com/node-escpos.png","language":"TypeScript","readme":"# @node-escpos\n\n\u003cbr/\u003e\n\u003cbr/\u003e\n\u003cp align=\"center\"\u003e🖨️ ESC/POS Printer driver for Node.js.\u003c/p\u003e\n\u003cbr/\u003e\n\n![Hacktober Badge](https://img.shields.io/badge/hacktoberfest-2022-blueviolet)\n\n---\n\n\nhttps://user-images.githubusercontent.com/32405058/208310580-25466637-2b3e-4928-b4e6-6ceb07735136.mp4\n\n\n[📢 RFC] Recently I'm working on a new workflow that prints the receipt. HTML+CSS will customize the content. Theoretically, we can print anything that we want. The workflow is like this:\n1. 🎨 rendering \n```tsx\n\u003cdiv id=\"label-dom\"\u003e Label/Receipt \u003c/div\u003e\n```\n2. 📸 capturing\n```tsx\nconst screenshort = await capture(document.getElementByID(\"label-dom\"))\n```\n3. 🧾 printing\n```tsx\nconst printer = await printer.image(screenshort, \"s8\")\nprinter.cut().close()\n```\n\nBut my full-time job is very busy. So the progress is slow, And any sponsorship will encourage me to work more actively in the open-source community. \n\n---\n\n\n### Improvements\n- 🛠 TypeScript.\n- 📦 pnpm.\n- 🟢 vitest.\n- 🚀 More stable maintenance.\n- 🔴 Printing by HTML+CSS(WIP).\n- 💡 More ideas.\n- ...\n\n### Packages\n\n- [@node-escpos/core](packages/core/README.md)  [![npm](https://img.shields.io/npm/v/@node-escpos/core.svg?style=flat-square)](https://www.npmjs.com/package/@node-escpos/core) [![npm](https://img.shields.io/npm/dm/@node-escpos/core.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/core) [![npm](https://img.shields.io/npm/dw/@node-escpos/core.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/core)\n\n- [@node-escpos/adapter](packages/adapter/README.md)  [![npm](https://img.shields.io/npm/v/@node-escpos/adapter.svg?style=flat-square)](https://www.npmjs.com/package/@node-escpos/adapter) [![npm](https://img.shields.io/npm/dm/@node-escpos/adapter.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/adapter) [![npm](https://img.shields.io/npm/dw/@node-escpos/adapter.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/adapter)\n\n- [@node-escpos/console](packages/console/README.md)  [![npm](https://img.shields.io/npm/v/@node-escpos/console.svg?style=flat-square)](https://www.npmjs.com/package/@node-escpos/console) [![npm](https://img.shields.io/npm/dm/@node-escpos/console.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/console) [![npm](https://img.shields.io/npm/dw/@node-escpos/console.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/console)\n\n- [@node-escpos/screen](packages/screen/README.md)  [![npm](https://img.shields.io/npm/v/@node-escpos/screen.svg?style=flat-square)](https://www.npmjs.com/package/@node-escpos/screen) [![npm](https://img.shields.io/npm/dm/@node-escpos/screen.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/screen) [![npm](https://img.shields.io/npm/dw/@node-escpos/screen.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/screen)\n\n- [@node-escpos/server](packages/server/README.md)  [![npm](https://img.shields.io/npm/v/@node-escpos/server.svg?style=flat-square)](https://www.npmjs.com/package/@node-escpos/server) [![npm](https://img.shields.io/npm/dm/@node-escpos/server.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/server) [![npm](https://img.shields.io/npm/dw/@node-escpos/server.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/server)\n\n- [@node-escpos/network-adapter](packages/network-adapter/README.md)  [![npm](https://img.shields.io/npm/v/@node-escpos/network-adapter.svg?style=flat-square)](https://www.npmjs.com/package/@node-escpos/network-adapter) [![npm](https://img.shields.io/npm/dm/@node-escpos/network-adapter.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/network-adapter) [![npm](https://img.shields.io/npm/dw/@node-escpos/network-adapter.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/network-adapter)\n\n- [@node-escpos/usb-adapter](packages/usb-adapter/README.md)  [![npm](https://img.shields.io/npm/v/@node-escpos/usb-adapter.svg?style=flat-square)](https://www.npmjs.com/package/@node-escpos/usb-adapter) [![npm](https://img.shields.io/npm/dm/@node-escpos/usb-adapter.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/usb-adapter) [![npm](https://img.shields.io/npm/dw/@node-escpos/usb-adapter.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/usb-adapter)\n\n- [@node-escpos/serialport-adapter](packages/serialport-adapter/README.md)  [![npm](https://img.shields.io/npm/v/@node-escpos/serialport-adapter.svg?style=flat-square)](https://www.npmjs.com/package/@node-escpos/serialport-adapter) [![npm](https://img.shields.io/npm/dm/@node-escpos/serialport-adapter.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/serialport-adapter) [![npm](https://img.shields.io/npm/dw/@node-escpos/serialport-adapter.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/serialport-adapter)\t\n\n- [@node-escpos/bluetooth-adapter](packages/bluetooth-adapter/README.md)  [![npm](https://img.shields.io/npm/v/@node-escpos/bluetooth-adapter.svg?style=flat-square)](https://www.npmjs.com/package/@node-escpos/bluetooth-adapter) [![npm](https://img.shields.io/npm/dm/@node-escpos/bluetooth-adapter.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/bluetooth-adapter) [![npm](https://img.shields.io/npm/dw/@node-escpos/bluetooth-adapter.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/@node-escpos/bluetooth-adapter)\t\n\n\n## Example\n\n````javascript\nimport { Printer, Image } from \"@node-escpos/core\";\n// install escpos-usb adapter module manually\nimport USB from \"@node-escpos/usb-adapter\";\n// Select the adapter based on your printer type\nimport { join } from \"path\";\n\nconst device = new USB();\n\ndevice.open(async function(err){\n  if(err){\n    // handle error\n    return\n  }\n\n  // encoding is optional\n  const options = { encoding: \"GB18030\" /* default */ }\n  let printer = new Printer(device, options);\n\n  // Path to png image\n  const filePath = join(\"/PATH/TO/IMAGE\");\n  const image = await Image.load(filePath);\n\n  printer\n    .font(\"a\")\n    .align(\"ct\")\n    .style(\"bu\")\n    .size(1, 1)\n    .text(\"May the gold fill your pocket\")\n    .text(\"恭喜发财\")\n    .barcode(112233445566, \"EAN13\", { width: 50, height: 50 })\n    .table([\"One\", \"Two\", \"Three\"])\n    .tableCustom(\n      [\n        { text: \"Left\", align: \"LEFT\", width: 0.33, style: \"B\" },\n        { text: \"Center\", align: \"CENTER\", width: 0.33 },\n        { text: \"Right\", align: \"RIGHT\", width: 0.33 },\n      ],\n      { encoding: \"cp857\", size: [1, 1] }, // Optional\n    )\n    \n  // inject qrimage to printer\n  printer = await printer.qrimage(\"https://github.com/node-escpos/driver\")\n  // inject image to printer\n  printer = await printer.image(\n    image, \n    \"s8\" // changing with image\n  )\n\n  printer\n    .cut()\n    .close()\n});\n````\n- See [`./examples/demo/test`](https://github.com/node-escpos/driver/tree/main/examples/demo/test) for more examples.\n\n\n## Sponsors\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src='https://github.com/dohooo/sponsors/blob/master/sponsors.png?raw=true'/\u003e\n\u003c/p\u003e\n\n## License\n\n[MIT](./LICENSE) License © 2022 [Dohooo](https://github.com/dohooo)\n","funding_links":["https://github.com/sponsors/dohooo"],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnode-escpos%2Fdriver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnode-escpos%2Fdriver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnode-escpos%2Fdriver/lists"}