{ "api": { "name": "BrotherPrintPlugin", "slug": "brotherprintplugin", "docs": "", "tags": [], "methods": [ { "name": "printImage", "signature": "(options: BRLMPrintOptions) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "BRLMPrintOptions" } ], "returns": "Promise", "tags": [], "docs": "", "complexTypes": [ "BRLMPrintOptions" ], "slug": "printimage" }, { "name": "search", "signature": "(option: BRLMSearchOption) => Promise", "parameters": [ { "name": "option", "docs": "", "type": "BRLMSearchOption" } ], "returns": "Promise", "tags": [], "docs": "Search for printers. If not found, it will return an empty array.(not error)", "complexTypes": [ "BRLMSearchOption" ], "slug": "search" }, { "name": "cancelSearchWiFiPrinter", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [], "docs": "Basically, it times out, so there is no need to use it. Use it when you want to run multiple connectType searches at the same time and time out any of them manually.", "complexTypes": [], "slug": "cancelsearchwifiprinter" }, { "name": "cancelSearchBluetoothPrinter", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [], "docs": "Basically, it times out, so there is no need to use it. Use it when you want to run multiple connectType searches at the same time and time out any of them manually.", "complexTypes": [], "slug": "cancelsearchbluetoothprinter" }, { "name": "getPrinterStatus", "signature": "(option: GetPrinterStatusOption) => Promise", "parameters": [ { "name": "option", "docs": "", "type": "GetPrinterStatusOption" } ], "returns": "Promise", "tags": [], "docs": "Get the printer status.", "complexTypes": [ "GetPrinterStatusOption" ], "slug": "getprinterstatus" }, { "name": "addListener", "signature": "(eventName: BrotherPrintEventsEnum.onPrinterAvailable, listenerFunc: (printers: BRLMChannelResult) => void) => Promise", "parameters": [ { "name": "eventName", "docs": "", "type": "BrotherPrintEventsEnum.onPrinterAvailable" }, { "name": "listenerFunc", "docs": "", "type": "(printers: BRLMChannelResult) => void" } ], "returns": "Promise", "tags": [], "docs": "Find the printer that can connected to the device.", "complexTypes": [ "PluginListenerHandle", "BrotherPrintEventsEnum", "BRLMChannelResult" ], "slug": "addlistenerbrotherprinteventsenumonprinteravailable-" }, { "name": "addListener", "signature": "(eventName: BrotherPrintEventsEnum.onPrint, listenerFunc: () => void) => Promise", "parameters": [ { "name": "eventName", "docs": "", "type": "BrotherPrintEventsEnum.onPrint" }, { "name": "listenerFunc", "docs": "", "type": "() => void" } ], "returns": "Promise", "tags": [], "docs": "Success Print Event", "complexTypes": [ "PluginListenerHandle", "BrotherPrintEventsEnum" ], "slug": "addlistenerbrotherprinteventsenumonprint-" }, { "name": "addListener", "signature": "(eventName: BrotherPrintEventsEnum.onPrintFailedCommunication, listenerFunc: (info: ErrorInfo) => void) => Promise", "parameters": [ { "name": "eventName", "docs": "", "type": "BrotherPrintEventsEnum.onPrintFailedCommunication" }, { "name": "listenerFunc", "docs": "", "type": "(info: ErrorInfo) => void" } ], "returns": "Promise", "tags": [], "docs": "Failed to connect to the printer.\nex: Bluetooth is off, Printer is off, etc.", "complexTypes": [ "PluginListenerHandle", "BrotherPrintEventsEnum", "ErrorInfo" ], "slug": "addlistenerbrotherprinteventsenumonprintfailedcommunication-" }, { "name": "addListener", "signature": "(eventName: BrotherPrintEventsEnum.onPrintError, listenerFunc: (info: ErrorInfo) => void) => Promise", "parameters": [ { "name": "eventName", "docs": "", "type": "BrotherPrintEventsEnum.onPrintError" }, { "name": "listenerFunc", "docs": "", "type": "(info: ErrorInfo) => void" } ], "returns": "Promise", "tags": [], "docs": "Failed to print.", "complexTypes": [ "PluginListenerHandle", "BrotherPrintEventsEnum", "ErrorInfo" ], "slug": "addlistenerbrotherprinteventsenumonprinterror-" }, { "name": "addListener", "signature": "(eventName: BrotherPrintEventsEnum.onPrinterStatus, listenerFunc: (status: BRLMPrinterStatus) => void) => Promise", "parameters": [ { "name": "eventName", "docs": "", "type": "BrotherPrintEventsEnum.onPrinterStatus" }, { "name": "listenerFunc", "docs": "", "type": "(status: BRLMPrinterStatus) => void" } ], "returns": "Promise", "tags": [], "docs": "Get the printer status.", "complexTypes": [ "PluginListenerHandle", "BrotherPrintEventsEnum", "BRLMPrinterStatus" ], "slug": "addlistenerbrotherprinteventsenumonprinterstatus-" } ], "properties": [] }, "interfaces": [ { "name": "PluginListenerHandle", "slug": "pluginlistenerhandle", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "remove", "tags": [], "docs": "", "complexTypes": [], "type": "() => Promise" } ] } ], "enums": [ { "name": "BRLMPrinterModelName", "slug": "brlmprintermodelname", "members": [ { "name": "QL_810W", "value": "'QL_810W'", "tags": [], "docs": "" }, { "name": "QL_820NWB", "value": "'QL_820NWB'", "tags": [], "docs": "" }, { "name": "TD_2120N", "value": "'TD_2120N'", "tags": [], "docs": "" }, { "name": "TD_2130N", "value": "'TD_2130N'", "tags": [], "docs": "" }, { "name": "TD_4550DNWB", "value": "'TD_4550DNWB'", "tags": [], "docs": "" } ] }, { "name": "BRLMPrinterPort", "slug": "brlmprinterport", "members": [ { "name": "usb", "value": "'usb'", "tags": [], "docs": "" }, { "name": "wifi", "value": "'wifi'", "tags": [], "docs": "" }, { "name": "bluetooth", "value": "'bluetooth'", "tags": [], "docs": "" }, { "name": "bluetoothLowEnergy", "value": "'bluetoothLowEnergy'", "tags": [], "docs": "" } ] }, { "name": "BRLMPrinterLabelName", "slug": "brlmprinterlabelname", "members": [ { "name": "DieCutW17H54", "value": "'DieCutW17H54'", "tags": [], "docs": "" }, { "name": "DieCutW17H87", "value": "'DieCutW17H87'", "tags": [], "docs": "" }, { "name": "DieCutW23H23", "value": "'DieCutW23H23'", "tags": [], "docs": "" }, { "name": "DieCutW29H42", "value": "'DieCutW29H42'", "tags": [], "docs": "" }, { "name": "DieCutW29H90", "value": "'DieCutW29H90'", "tags": [], "docs": "" }, { "name": "DieCutW38H90", "value": "'DieCutW38H90'", "tags": [], "docs": "" }, { "name": "DieCutW39H48", "value": "'DieCutW39H48'", "tags": [], "docs": "" }, { "name": "DieCutW52H29", "value": "'DieCutW52H29'", "tags": [], "docs": "" }, { "name": "DieCutW62H29", "value": "'DieCutW62H29'", "tags": [], "docs": "" }, { "name": "DieCutW62H60", "value": "'DieCutW62H60'", "tags": [], "docs": "" }, { "name": "DieCutW62H75", "value": "'DieCutW62H75'", "tags": [], "docs": "" }, { "name": "DieCutW62H100", "value": "'DieCutW62H100'", "tags": [], "docs": "" }, { "name": "DieCutW60H86", "value": "'DieCutW60H86'", "tags": [], "docs": "" }, { "name": "DieCutW54H29", "value": "'DieCutW54H29'", "tags": [], "docs": "" }, { "name": "DieCutW102H51", "value": "'DieCutW102H51'", "tags": [], "docs": "" }, { "name": "DieCutW102H152", "value": "'DieCutW102H152'", "tags": [], "docs": "" }, { "name": "DieCutW103H164", "value": "'DieCutW103H164'", "tags": [], "docs": "" }, { "name": "RollW12", "value": "'RollW12'", "tags": [], "docs": "" }, { "name": "RollW29", "value": "'RollW29'", "tags": [], "docs": "" }, { "name": "RollW38", "value": "'RollW38'", "tags": [], "docs": "" }, { "name": "RollW50", "value": "'RollW50'", "tags": [], "docs": "" }, { "name": "RollW54", "value": "'RollW54'", "tags": [], "docs": "" }, { "name": "RollW62", "value": "'RollW62'", "tags": [], "docs": "" }, { "name": "RollW62RB", "value": "'RollW62RB'", "tags": [], "docs": "" }, { "name": "RollW102", "value": "'RollW102'", "tags": [], "docs": "" }, { "name": "RollW103", "value": "'RollW103'", "tags": [], "docs": "" }, { "name": "DTRollW90", "value": "'DTRollW90'", "tags": [], "docs": "" }, { "name": "DTRollW102", "value": "'DTRollW102'", "tags": [], "docs": "" }, { "name": "DTRollW102H51", "value": "'DTRollW102H51'", "tags": [], "docs": "" }, { "name": "DTRollW102H152", "value": "'DTRollW102H152'", "tags": [], "docs": "" }, { "name": "RoundW12DIA", "value": "'RoundW12DIA'", "tags": [], "docs": "" }, { "name": "RoundW24DIA", "value": "'RoundW24DIA'", "tags": [], "docs": "" }, { "name": "RoundW58DIA", "value": "'RoundW58DIA'", "tags": [], "docs": "" }, { "name": "RDDieCutW60H60", "value": "'RDDieCutW60H60'", "tags": [ { "text": "https://www.brother.co.jp/product/labelprinter/td2350d/accessory/index.aspx", "name": "url" } ], "docs": "For TD series" }, { "name": "RDDieCutW50H30", "value": "'RDDieCutW50H30'", "tags": [], "docs": "" }, { "name": "RDDieCutW40H60", "value": "'RDDieCutW40H60'", "tags": [], "docs": "" }, { "name": "RDDieCutW40H50", "value": "'RDDieCutW40H50'", "tags": [], "docs": "" }, { "name": "RDDieCutW40H40", "value": "'RDDieCutW40H40'", "tags": [], "docs": "" }, { "name": "RDDieCutW30H30", "value": "'RDDieCutW30H30'", "tags": [], "docs": "" }, { "name": "RDDieCutW50H35", "value": "'RDDieCutW50H35'", "tags": [], "docs": "" }, { "name": "RDDieCutW60H80", "value": "'RDDieCutW60H80'", "tags": [], "docs": "" }, { "name": "RDDieCutW60H100", "value": "'RDDieCutW60H100'", "tags": [], "docs": "" } ] }, { "name": "BRLMPrinterScaleMode", "slug": "brlmprinterscalemode", "members": [ { "name": "ActualSize", "value": "'ActualSize'", "tags": [], "docs": "" }, { "name": "FitPageAspect", "value": "'FitPageAspect'", "tags": [], "docs": "" }, { "name": "FitPaperAspect", "value": "'FitPaperAspect'", "tags": [], "docs": "" }, { "name": "ScaleValue", "value": "'ScaleValue'", "tags": [], "docs": "" } ] }, { "name": "BRLMPrinterHalftone", "slug": "brlmprinterhalftone", "members": [ { "name": "Threshold", "value": "'Threshold'", "tags": [], "docs": "" }, { "name": "ErrorDiffusion", "value": "'ErrorDiffusion'", "tags": [], "docs": "" }, { "name": "PatternDither", "value": "'PatternDither'", "tags": [], "docs": "" } ] }, { "name": "BRLMPrinterImageRotation", "slug": "brlmprinterimagerotation", "members": [ { "name": "Rotate0", "value": "'Rotate0'", "tags": [], "docs": "" }, { "name": "Rotate90", "value": "'Rotate90'", "tags": [], "docs": "" }, { "name": "Rotate180", "value": "'Rotate180'", "tags": [], "docs": "" }, { "name": "Rotate270", "value": "'Rotate270'", "tags": [], "docs": "" } ] }, { "name": "BRLMPrinterVerticalAlignment", "slug": "brlmprinterverticalalignment", "members": [ { "name": "Top", "value": "'Top'", "tags": [], "docs": "" }, { "name": "Center", "value": "'Center'", "tags": [], "docs": "" }, { "name": "Bottom", "value": "'Bottom'", "tags": [], "docs": "" } ] }, { "name": "BRLMPrinterHorizontalAlignment", "slug": "brlmprinterhorizontalalignment", "members": [ { "name": "Left", "value": "'Left'", "tags": [], "docs": "" }, { "name": "Center", "value": "'Center'", "tags": [], "docs": "" }, { "name": "Right", "value": "'Right'", "tags": [], "docs": "" } ] }, { "name": "BRLMPrinterCompressMode", "slug": "brlmprintercompressmode", "members": [ { "name": "None", "value": "'None'", "tags": [], "docs": "" }, { "name": "Tiff", "value": "'Tiff'", "tags": [], "docs": "" }, { "name": "Mode9", "value": "'Mode9'", "tags": [], "docs": "" } ] }, { "name": "BRLMPrinterPrintQuality", "slug": "brlmprinterprintquality", "members": [ { "name": "Best", "value": "'Best'", "tags": [], "docs": "" }, { "name": "Fast", "value": "'Fast'", "tags": [], "docs": "" } ] }, { "name": "BRLMPrinterCustomPaperType", "slug": "brlmprintercustompapertype", "members": [ { "name": "rollPaper", "value": "'rollPaper'", "tags": [], "docs": "" }, { "name": "dieCutPaper", "value": "'dieCutPaper'", "tags": [], "docs": "" }, { "name": "markRollPaper", "value": "'markRollPaper'", "tags": [], "docs": "" } ] }, { "name": "BRLMPrinterCustomPaperUnit", "slug": "brlmprintercustompaperunit", "members": [ { "name": "mm", "value": "'mm'", "tags": [], "docs": "" }, { "name": "inch", "value": "'inch'", "tags": [], "docs": "" } ] }, { "name": "BrotherPrintEventsEnum", "slug": "brotherprinteventsenum", "members": [ { "name": "onPrinterAvailable", "value": "'onPrinterAvailable'", "tags": [], "docs": "" }, { "name": "onPrint", "value": "'onPrint'", "tags": [], "docs": "" }, { "name": "onPrintFailedCommunication", "value": "'onPrintFailedCommunication'", "tags": [], "docs": "" }, { "name": "onPrintError", "value": "'onPrintError'", "tags": [], "docs": "" }, { "name": "onPrinterStatus", "value": "'onPrinterStatus'", "tags": [], "docs": "" } ] } ], "typeAliases": [ { "name": "BRLMPrintOptions", "slug": "brlmprintoptions", "docs": "", "types": [ { "text": "{\n encodedImage: string;\n\n /**\n * Should use enum BRLMPrinterModelName\n */\n modelName: BRLMPrinterModelName;\n} & Partial &\n (BRLMPrinterQLModelSettings | BRLMPrinterTDModelSettings)", "complexTypes": [ "BRLMPrinterModelName", "Partial", "BRLMChannelResult", "BRLMPrinterQLModelSettings", "BRLMPrinterTDModelSettings" ] } ] }, { "name": "Partial", "slug": "partial", "docs": "Make all properties in T optional", "types": [ { "text": "{\r\n [P in keyof T]?: T[P];\r\n}", "complexTypes": [ "T", "P" ] } ] }, { "name": "BRLMChannelResult", "slug": "brlmchannelresult", "docs": "", "types": [ { "text": "{\n port: BRLMPrinterPort;\n modelName: BRLMPrinterModelName;\n serialNumber: string;\n macAddress: string;\n nodeName: string;\n location: string;\n\n /**\n * This need to connect to the printer.\n * wifi: IP Address\n * bluetooth: macAddress\n * bluetoothLowEnergy: modelName for bluetoothLowEnergy\n */\n channelInfo: string;\n}", "complexTypes": [ "BRLMPrinterPort", "BRLMPrinterModelName" ] } ] }, { "name": "BRLMPrinterQLModelSettings", "slug": "brlmprinterqlmodelsettings", "docs": "", "types": [ { "text": "{\n /**\n * Should use enum BRLMPrinterLabelName\n */\n labelName: BRLMPrinterLabelName;\n} & BRLMPrinterSettings", "complexTypes": [ "BRLMPrinterLabelName", "BRLMPrinterSettings" ] } ] }, { "name": "BRLMPrinterSettings", "slug": "brlmprintersettings", "docs": "These are optional. If these are not set, default values are assigned by the printer.", "types": [ { "text": "{\n /**\n * The number of copies you print.\n */\n numberOfCopies?: BRLMPrinterNumberOfCopies;\n\n /**\n * Whether the auto-cut is enabled or not. If true, your printer cut the paper each page.\n */\n autoCut?: BRLMPrinterAutoCutType;\n\n /**\n * A scale mode that specifies how your data is scaled in a print area of your printer.\n */\n scaleMode?: BRLMPrinterScaleMode;\n\n /**\n * A scale value. This is effective when ScaleMode is ScaleValue.\n */\n scaleValue?: BRLMPrinterScaleValueType;\n\n /**\n * A way to rasterize your data.\n */\n halftone?: BRLMPrinterHalftone;\n\n /**\n * A threshold value. This is effective when the Halftone is Threshold.\n */\n halftoneThreshold?: BRLMPrinterHalftoneThresholdType;\n\n /**\n * An image rotation that specifies the angle in which your data is placed in the print area. Rotation direction is clockwise.\n */\n imageRotation?: BRLMPrinterImageRotation;\n\n /**\n * A vertical alignment that specifies how your data is placed in the printable area.\n */\n verticalAlignment?: BRLMPrinterVerticalAlignment;\n\n /**\n * A horizontal alignment that specifies how your data is placed in the printable area.\n */\n horizontalAlignment?: BRLMPrinterHorizontalAlignment;\n\n /**\n * A compress mode that specifies how to compress your data.\n * note: This is ios only.\n */\n compressMode?: BRLMPrinterCompressMode;\n\n /**\n * A priority that is print speed or print quality. Whether or not this has an effect is depend on your printer.\n */\n printQuality?: BRLMPrinterPrintQuality;\n}", "complexTypes": [ "BRLMPrinterNumberOfCopies", "BRLMPrinterAutoCutType", "BRLMPrinterScaleMode", "BRLMPrinterScaleValueType", "BRLMPrinterHalftone", "BRLMPrinterHalftoneThresholdType", "BRLMPrinterImageRotation", "BRLMPrinterVerticalAlignment", "BRLMPrinterHorizontalAlignment", "BRLMPrinterCompressMode", "BRLMPrinterPrintQuality" ] } ] }, { "name": "BRLMPrinterNumberOfCopies", "slug": "brlmprinternumberofcopies", "docs": "", "types": [ { "text": "number", "complexTypes": [] } ] }, { "name": "BRLMPrinterAutoCutType", "slug": "brlmprinterautocuttype", "docs": "", "types": [ { "text": "boolean", "complexTypes": [] } ] }, { "name": "BRLMPrinterScaleValueType", "slug": "brlmprinterscalevaluetype", "docs": "", "types": [ { "text": "number", "complexTypes": [] } ] }, { "name": "BRLMPrinterHalftoneThresholdType", "slug": "brlmprinterhalftonethresholdtype", "docs": "", "types": [ { "text": "number", "complexTypes": [] } ] }, { "name": "BRLMPrinterTDModelSettings", "slug": "brlmprintertdmodelsettings", "docs": "", "types": [ { "text": "{\n /**\n * Should use enum BRKMPrinterCustomPaperType\n */\n paperType: BRLMPrinterCustomPaperType;\n\n /**\n * The width of the label. For example, the RD-U04J1 is 60.0 wide.\n */\n tapeWidth: number;\n\n /**\n * The length of the label. For example, the RD-U04J1 is 60.0 wide.\n */\n tapeLength: number;\n\n /**\n * It is the difference between a sticker and a mount.\n * For example, the RD-U04J1 is `1.0, 2.0, 1.0, 2.0`\n */\n marginTop: number;\n marginRight: number;\n marginBottom: number;\n marginLeft: number;\n\n /**\n * The spacing between seals. For example, the RD-U04J1 is 0.2.\n */\n gapLength: number;\n\n paperMarkPosition: number;\n paperMarkLength: number;\n\n /**\n * Should use enum BRKMPrinterCustomPaperUnit.\n * For example, the RD-U04J1 is mm.\n */\n paperUnit: BRLMPrinterCustomPaperUnit;\n}", "complexTypes": [ "BRLMPrinterCustomPaperType", "BRLMPrinterCustomPaperUnit" ] } ] }, { "name": "BRLMSearchOption", "slug": "brlmsearchoption", "docs": "", "types": [ { "text": "{\n /**\n * 'usb' is android only, and now developing.\n */\n port: BRLMPrinterPort;\n\n /**\n * searchDuration is the time to end search for devices.\n * default is 15 seconds.\n * use only port is 'wifi' or 'bluetoothLowEnergy'.\n */\n searchDuration: number;\n}", "complexTypes": [ "BRLMPrinterPort" ] } ] }, { "name": "GetPrinterStatusOption", "slug": "getprinterstatusoption", "docs": "", "types": [ { "text": "{\n channelInfo: string;\n port: BRLMPrinterPort;\n}", "complexTypes": [ "BRLMPrinterPort" ] } ] }, { "name": "ErrorInfo", "slug": "errorinfo", "docs": "", "types": [ { "text": "{\n message: string;\n code: number;\n}", "complexTypes": [] } ] }, { "name": "BRLMPrinterStatus", "slug": "brlmprinterstatus", "docs": "", "types": [ { "text": "{\n model: unknown;\n batteryStatus: unknown;\n mediaInfo: BRLMMediaInfo;\n}", "complexTypes": [ "BRLMMediaInfo" ] } ] }, { "name": "BRLMMediaInfo", "slug": "brlmmediainfo", "docs": "", "types": [ { "text": "{\n labelSize: BRLMPrinterLabelName;\n}", "complexTypes": [ "BRLMPrinterLabelName" ] } ] } ], "pluginConfigs": [] }