API

method printImage(...)

printImage(options: BRLMPrintOptions) => Promise<void>

method search(...)

search(option: BRLMSearchOption) => Promise<void>

Search for printers. If not found, it will return an empty array.(not error)

method isChannelAvailable(...)

isChannelAvailable(option: BRLMChannelResult) => Promise<isChannelAvailableResult>

If you have saved the last connected BRLMChannelResult,
you can use it to verify whether it is currently usable.

Returns: Promise<isChannelAvailableResult>

method cancelSearchWiFiPrinter()

cancelSearchWiFiPrinter() => Promise<void>

Stop an active search before its timeout, including when leaving the screen.

method cancelSearchBluetoothPrinter()

cancelSearchBluetoothPrinter() => Promise<void>

Stop an active search before its timeout, including when leaving the screen.

method addListener(BrotherPrintEventsEnum.onPrinterAvailable, ...)

addListener(eventName: BrotherPrintEventsEnum.onPrinterAvailable, listenerFunc: (printers: BRLMChannelResult) => void) => Promise<PluginListenerHandle>

Find the printer that can connected to the device.

Returns: Promise<PluginListenerHandle>

method addListener(BrotherPrintEventsEnum.onPrint, ...)

addListener(eventName: BrotherPrintEventsEnum.onPrint, listenerFunc: () => void) => Promise<PluginListenerHandle>

Success Print Event

Returns: Promise<PluginListenerHandle>

method addListener(BrotherPrintEventsEnum.onPrintFailedCommunication, ...)

addListener(eventName: BrotherPrintEventsEnum.onPrintFailedCommunication, listenerFunc: (info: ErrorInfo) => void) => Promise<PluginListenerHandle>

Failed to connect to the printer.
ex: Bluetooth is off, Printer is off, etc.

Returns: Promise<PluginListenerHandle>

method addListener(BrotherPrintEventsEnum.onPrintError, ...)

addListener(eventName: BrotherPrintEventsEnum.onPrintError, listenerFunc: (info: ErrorInfo) => void) => Promise<PluginListenerHandle>

Failed to print.

Returns: Promise<PluginListenerHandle>

interface PluginListenerHandle

type alias BRLMPrintOptions

{ encodedImage: string; /** * Should use enum BRLMPrinterModelName */ modelName: BRLMPrinterModelName; } & Partial<BRLMChannelResult> & (BRLMPrinterQLModelSettings | BRLMPrinterTDModelSettings)

type alias Partial

Make all properties in T optional

{ [P in keyof T]?: T[P]; }

type alias BRLMChannelResult

{ port: BRLMPrinterPort; modelName: string; serialNumber: string; macAddress: string; nodeName: string; location: string; /** * This need to connect to the printer. * wifi: IP Address * bluetooth: macAddress * bluetoothLowEnergy: modelName for bluetoothLowEnergy */ channelInfo: string; }

type alias BRLMPrinterQLModelSettings

{ /** * Should use enum BRLMPrinterLabelName */ labelName: BRLMPrinterLabelName; } & BRLMPrinterSettings

type alias BRLMPrinterSettings

These are optional. If these are not set, default values are assigned by the printer.

{ /** * The number of copies you print. */ numberOfCopies?: BRLMPrinterNumberOfCopies; /** * Whether the auto-cut is enabled or not. If true, your printer cut the paper each page. */ autoCut?: BRLMPrinterAutoCutType; /** * A scale mode that specifies how your data is scaled in a print area of your printer. */ scaleMode?: BRLMPrinterScaleMode; /** * A scale value. This is effective when ScaleMode is ScaleValue. */ scaleValue?: BRLMPrinterScaleValueType; /** * A way to rasterize your data. */ halftone?: BRLMPrinterHalftone; /** * A threshold value. This is effective when the Halftone is Threshold. */ halftoneThreshold?: BRLMPrinterHalftoneThresholdType; /** * An image rotation that specifies the angle in which your data is placed in the print area. Rotation direction is clockwise. */ imageRotation?: BRLMPrinterImageRotation; /** * A vertical alignment that specifies how your data is placed in the printable area. */ verticalAlignment?: BRLMPrinterVerticalAlignment; /** * A horizontal alignment that specifies how your data is placed in the printable area. */ horizontalAlignment?: BRLMPrinterHorizontalAlignment; /** * A compress mode that specifies how to compress your data. * note: This is ios only. */ compressMode?: BRLMPrinterCompressMode; /** * A priority that is print speed or print quality. Whether or not this has an effect is depend on your printer. */ printQuality?: BRLMPrinterPrintQuality; }

type alias BRLMPrinterNumberOfCopies

number

type alias BRLMPrinterAutoCutType

boolean

type alias BRLMPrinterScaleValueType

number

type alias BRLMPrinterHalftoneThresholdType

number

type alias BRLMPrinterTDModelSettings

{ /** * Should use enum BRKMPrinterCustomPaperType */ paperType: BRLMPrinterCustomPaperType; /** * The width of the label. For example, the RD-U04J1 is 60.0 wide. */ tapeWidth: number; /** * The length of the label. For example, the RD-U04J1 is 60.0 wide. */ tapeLength: number; /** * It is the difference between a sticker and a mount. * For example, the RD-U04J1 is `1.0, 2.0, 1.0, 2.0` */ marginTop: number; marginRight: number; marginBottom: number; marginLeft: number; /** * The spacing between seals. For example, the RD-U04J1 is 0.2. */ gapLength: number; paperMarkPosition: number; paperMarkLength: number; /** * Should use enum BRKMPrinterCustomPaperUnit. * For example, the RD-U04J1 is mm. */ paperUnit: BRLMPrinterCustomPaperUnit; }

type alias BRLMSearchOption

{ /** * 'usb' is android only, and now developing. */ port: BRLMPrinterPort; /** * searchDuration is the time to end search for devices. * default is 15 seconds. * use only port is 'wifi' or 'bluetoothLowEnergy'. */ searchDuration: number; /** * Android Bluetooth Classic only. Include only devices whose Bluetooth class * reports a printer. Defaults to false; ignored for other ports and on iOS. * This does not identify Brother devices. Devices with an unknown class are excluded when true. */ bluetoothPrintersOnly?: boolean; }

type alias isChannelAvailableResult

{ result: boolean; }

type alias ErrorInfo

{ message: string; code: number; }

enum BRLMPrinterModelName

enum BRLMPrinterPort

enum BRLMPrinterLabelName

enum BRLMPrinterScaleMode

enum BRLMPrinterHalftone

enum BRLMPrinterImageRotation

enum BRLMPrinterVerticalAlignment

enum BRLMPrinterHorizontalAlignment

enum BRLMPrinterCompressMode

enum BRLMPrinterPrintQuality

enum BRLMPrinterCustomPaperType

enum BRLMPrinterCustomPaperUnit

enum BrotherPrintEventsEnum