-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add TypeScript types #1
Comments
Thanks for using ReceiptIO! |
Here's a rough template for the ReceiptIO types: declare module 'receiptio' {
import { Transform } from 'node:stream';
export type Printer =
| 'escpos'
| 'sii'
| 'citizen'
| 'fit'
| 'impact'
| 'impactb'
| 'star'
| 'starline'
| 'emustarline'
| 'stargraphic'
| 'svg'
| 'png';
export type Language =
| 'en'
| 'fr'
| 'de'
| 'es'
| 'po'
| 'it'
| 'ru'
| 'ja'
| 'ko'
| 'zh-hans'
| 'zh-hant'
| string; // Not all are listed, so allow arbitrary for now
export type PrintStatus =
| 'success'
| 'online'
| 'coveropen'
| 'paperempty'
| 'error'
| 'offline'
| 'disconnect'
| 'timeout';
export function print(receiptmd: string, options?: string): PrintStatus;
export function print(receiptmd: string, options?: string): string;
export function createPrint(options?: string): Transform;
} Not much I can do with the specific types as the options are passed as a string. Any chance options could also be passed as an object? I will update the types for that. |
It is a really great library. It was hard to find something in js that worked well for printing. It would be really lovely if it had types. Awesome job anyway! |
Looks like a great library, but missing TypeScript typings.
The text was updated successfully, but these errors were encountered: