@posx/capacitor-usb-printer

Capacitor plugin for

Install

npm install @posx/capacitor-usb-printer
npx cap sync

API

• listDevices()
• requestPermission(...)
• connect(...)
• disconnect(...)
• print(...)
• getStatus(...)
• addListener('deviceAttached', ...)
• addListener('deviceDetached', ...)
• Interfaces

listDevices()

listDevices() => Promise<{ devices: UsbDevice[]; }>

Returns: Promise<{ devices: UsbDevice[]; }>

requestPermission(...)

requestPermission(options: { deviceId: number; }) => Promise<{ granted: boolean; }>

| Param | Type | | ------------- | ---------------------------------- | | options | { deviceId: number; } |

Returns: Promise<{ granted: boolean; }>

connect(...)

connect(options: { deviceId: number; }) => Promise<{ connected: boolean; }>

| Param | Type | | ------------- | ---------------------------------- | | options | { deviceId: number; } |

Returns: Promise<{ connected: boolean; }>

disconnect(...)

disconnect(options: { deviceId: number; }) => Promise<void>

| Param | Type | | ------------- | ---------------------------------- | | options | { deviceId: number; } |

print(...)

print(options: { deviceId: number; data: string; }) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------ | | options | { deviceId: number; data: string; } |

getStatus(...)

getStatus(options: { deviceId: number; }) => Promise<{ connected: boolean; deviceName: string; serialNumber: string; }>

| Param | Type | | ------------- | ---------------------------------- | | options | { deviceId: number; } |

Returns: Promise<{ connected: boolean; deviceName: string; serialNumber: string; }>

addListener('deviceAttached', ...)

addListener(eventName: 'deviceAttached', listenerFunc: (device: UsbDevice) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | -------------------------------------------------------------------- | | eventName | 'deviceAttached' | | listenerFunc | (device: UsbDevice) => void |

Returns: Promise<PluginListenerHandle>

addListener('deviceDetached', ...)

addListener(eventName: 'deviceDetached', listenerFunc: (device: UsbDevice) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | -------------------------------------------------------------------- | | eventName | 'deviceDetached' | | listenerFunc | (device: UsbDevice) => void |

Returns: Promise<PluginListenerHandle>

Interfaces

UsbDevice

| Prop | Type | | ---------------------- | ------------------- | | deviceId | number | | vendorId | number | | productId | number | | deviceName | string | | portPath | string | | manufacturerName | string | | productName | string | | serialNumber | string |

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |