@rdlabo/capacitor-brotherprint 6.1.0 → 6.2.0-1

package/dist/docs.json

@@ -7,96 +7,93 @@
     "methods": [
       {
         "name": "printImage",
-        "signature": "(options: BrotherPrintOptions) => Promise<{ value: boolean; }>",
+        "signature": "(options: BRLMPrintOptions) => Promise<void>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "BrotherPrintOptions"
+            "type": "BRLMPrintOptions"
           }
         ],
-        "returns": "Promise<{ value: boolean; }>",
+        "returns": "Promise<void>",
         "tags": [],
         "docs": "",
         "complexTypes": [
-          "BrotherPrintOptions"
+          "BRLMPrintOptions"
         ],
         "slug": "printimage"
       },
       {
-        "name": "searchWiFiPrinter",
-        "signature": "() => Promise<void>",
-        "parameters": [],
+        "name": "search",
+        "signature": "(option: BRLMSearchOption) => Promise<void>",
+        "parameters": [
+          {
+            "name": "option",
+            "docs": "",
+            "type": "BRLMSearchOption"
+          }
+        ],
         "returns": "Promise<void>",
         "tags": [],
-        "docs": "",
-        "complexTypes": [],
-        "slug": "searchwifiprinter"
+        "docs": "Search for printers. If not found, it will return an empty array.(not error)",
+        "complexTypes": [
+          "BRLMSearchOption"
+        ],
+        "slug": "search"
       },
       {
-        "name": "searchBLEPrinter",
+        "name": "cancelSearchWiFiPrinter",
         "signature": "() => Promise<void>",
         "parameters": [],
         "returns": "Promise<void>",
         "tags": [],
-        "docs": "",
+        "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": "searchbleprinter"
+        "slug": "cancelsearchwifiprinter"
       },
       {
-        "name": "addListener",
-        "signature": "(eventName: 'onPrint', listenerFunc: () => void) => Promise<PluginListenerHandle>",
-        "parameters": [
-          {
-            "name": "eventName",
-            "docs": "",
-            "type": "'onPrint'"
-          },
-          {
-            "name": "listenerFunc",
-            "docs": "",
-            "type": "() => void"
-          }
-        ],
-        "returns": "Promise<PluginListenerHandle>",
+        "name": "cancelSearchBluetoothPrinter",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
         "tags": [],
-        "docs": "",
-        "complexTypes": [
-          "PluginListenerHandle"
-        ],
-        "slug": "addlisteneronprint"
+        "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": "addListener",
-        "signature": "(eventName: 'onBLEAvailable', listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: BrotherPrintEventsEnum.onPrinterAvailable, listenerFunc: (printers: BRLMChannelResult) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
             "docs": "",
-            "type": "'onBLEAvailable'"
+            "type": "BrotherPrintEventsEnum.onPrinterAvailable"
           },
           {
             "name": "listenerFunc",
             "docs": "",
-            "type": "() => void"
+            "type": "(printers: BRLMChannelResult) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle>",
         "tags": [],
         "docs": "",
         "complexTypes": [
-          "PluginListenerHandle"
+          "PluginListenerHandle",
+          "BrotherPrintEventsEnum",
+          "BRLMChannelResult"
         ],
-        "slug": "addlisteneronbleavailable"
+        "slug": "addlistenerbrotherprinteventsenumonprinteravailable"
       },
       {
         "name": "addListener",
-        "signature": "(eventName: 'onBLEAvailable', listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: BrotherPrintEventsEnum.onPrint, listenerFunc: () => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
             "docs": "",
-            "type": "'onBLEAvailable'"
+            "type": "BrotherPrintEventsEnum.onPrint"
           },
           {
             "name": "listenerFunc",
@@ -108,152 +105,631 @@
         "tags": [],
         "docs": "",
         "complexTypes": [
-          "PluginListenerHandle"
+          "PluginListenerHandle",
+          "BrotherPrintEventsEnum"
         ],
-        "slug": "addlisteneronbleavailable"
+        "slug": "addlistenerbrotherprinteventsenumonprint"
       },
       {
         "name": "addListener",
-        "signature": "(eventName: 'onIpAddressAvailable', listenerFunc: (info: { ipAddressList: string[]; }) => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: BrotherPrintEventsEnum.onPrintFailedCommunication, listenerFunc: (info: ErrorInfo) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
             "docs": "",
-            "type": "'onIpAddressAvailable'"
+            "type": "BrotherPrintEventsEnum.onPrintFailedCommunication"
           },
           {
             "name": "listenerFunc",
             "docs": "",
-            "type": "(info: { ipAddressList: string[]; }) => void"
+            "type": "(info: ErrorInfo) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle>",
         "tags": [],
         "docs": "",
         "complexTypes": [
-          "PluginListenerHandle"
+          "PluginListenerHandle",
+          "BrotherPrintEventsEnum",
+          "ErrorInfo"
         ],
-        "slug": "addlisteneronipaddressavailable"
+        "slug": "addlistenerbrotherprinteventsenumonprintfailedcommunication"
       },
       {
         "name": "addListener",
-        "signature": "(eventName: 'onPrintFailedCommunication', listenerFunc: (info: { value: string; }) => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: BrotherPrintEventsEnum.onPrintError, listenerFunc: (info: ErrorInfo) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
             "docs": "",
-            "type": "'onPrintFailedCommunication'"
+            "type": "BrotherPrintEventsEnum.onPrintError"
           },
           {
             "name": "listenerFunc",
             "docs": "",
-            "type": "(info: { value: string; }) => void"
+            "type": "(info: ErrorInfo) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle>",
         "tags": [],
         "docs": "",
         "complexTypes": [
-          "PluginListenerHandle"
+          "PluginListenerHandle",
+          "BrotherPrintEventsEnum",
+          "ErrorInfo"
         ],
-        "slug": "addlisteneronprintfailedcommunication"
-      },
-      {
-        "name": "addListener",
-        "signature": "(eventName: 'onPrintError', listenerFunc: (info: { value: string; }) => void) => Promise<PluginListenerHandle>",
-        "parameters": [
-          {
-            "name": "eventName",
-            "docs": "",
-            "type": "'onPrintError'"
-          },
-          {
-            "name": "listenerFunc",
-            "docs": "",
-            "type": "(info: { value: string; }) => void"
-          }
-        ],
-        "returns": "Promise<PluginListenerHandle>",
-        "tags": [],
-        "docs": "",
-        "complexTypes": [
-          "PluginListenerHandle"
-        ],
-        "slug": "addlisteneronprinterror"
+        "slug": "addlistenerbrotherprinteventsenumonprinterror"
       }
     ],
     "properties": []
   },
   "interfaces": [
     {
-      "name": "BrotherPrintOptions",
-      "slug": "brotherprintoptions",
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
       "docs": "",
       "tags": [],
       "methods": [],
       "properties": [
         {
-          "name": "encodedImage",
+          "name": "remove",
           "tags": [],
           "docs": "",
           "complexTypes": [],
-          "type": "string"
+          "type": "() => Promise<void>"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "BRLMPrinterLabelName",
+      "slug": "brlmprinterlabelname",
+      "members": [
+        {
+          "name": "W17H54",
+          "value": "'W17H54'",
+          "tags": [],
+          "docs": ""
         },
         {
-          "name": "printerType",
+          "name": "W17H87",
+          "value": "'W17H87'",
           "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "'QL-820NWB' | 'QL-800'"
+          "docs": ""
         },
         {
-          "name": "numberOfCopies",
+          "name": "W23H23",
+          "value": "'W23H23'",
           "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "number"
+          "docs": ""
         },
         {
-          "name": "labelNameIndex",
+          "name": "W29H42",
+          "value": "'W29H42'",
           "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "16 | 38"
+          "docs": ""
         },
         {
-          "name": "ipAddress",
+          "name": "W29H90",
+          "value": "'W29H90'",
           "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "string | undefined"
+          "docs": ""
         },
         {
-          "name": "localName",
+          "name": "W38H90",
+          "value": "'W38H90'",
           "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "string | undefined"
+          "docs": ""
+        },
+        {
+          "name": "W39H48",
+          "value": "'W39H48'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W52H29",
+          "value": "'W52H29'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W62H29",
+          "value": "'W62H29'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W62H100",
+          "value": "'W62H100'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W12",
+          "value": "'W12'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W29",
+          "value": "'W29'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W38",
+          "value": "'W38'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W50",
+          "value": "'W50'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W54",
+          "value": "'W54'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W62",
+          "value": "'W62'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W60H86",
+          "value": "'W60H86'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W62RB",
+          "value": "'W62RB'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W54H29",
+          "value": "'W54H29'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W12DIA",
+          "value": "'W12DIA'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W24DIA",
+          "value": "'W24DIA'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W58DIA",
+          "value": "'W58DIA'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W62H60",
+          "value": "'W62H60'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "W62H75",
+          "value": "'W62H75'",
+          "tags": [],
+          "docs": ""
         }
       ]
     },
     {
-      "name": "PluginListenerHandle",
-      "slug": "pluginlistenerhandle",
-      "docs": "",
-      "tags": [],
-      "methods": [],
-      "properties": [
+      "name": "BRLMPrinterModelName",
+      "slug": "brlmprintermodelname",
+      "members": [
         {
-          "name": "remove",
+          "name": "QL_810W",
+          "value": "'QL_810W'",
           "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "() => Promise<void>"
+          "docs": ""
+        },
+        {
+          "name": "QL_820NWB",
+          "value": "'QL_820NWB'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "TD_2320D_203",
+          "value": "'TD_2320D_203'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "TD_2030AD",
+          "value": "'TD_2030AD'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "TD_2350D_203",
+          "value": "'TD_2350D_203'",
+          "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": "BRLMPrinterPrintResolution",
+      "slug": "brlmprinterprintresolution",
+      "members": [
+        {
+          "name": "Low",
+          "value": "'Low'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "Normal",
+          "value": "'Normal'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "High",
+          "value": "'High'",
+          "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": ""
+        }
+      ]
+    }
+  ],
+  "typeAliases": [
+    {
+      "name": "BRLMPrintOptions",
+      "slug": "brlmprintoptions",
+      "docs": "",
+      "types": [
+        {
+          "text": "{\n  encodedImage: string;\n\n  /**\n   * Should use enum BRLMPrinterLabelName\n   */\n  labelName: BRLMPrinterLabelName;\n\n  /**\n   * Should use enum BRLMPrinterModelName\n   */\n  modelName: BRLMPrinterModelName;\n} & Partial<BRLMChannelResult> &\n  BRLMPrinterSettings",
+          "complexTypes": [
+            "BRLMPrinterLabelName",
+            "BRLMPrinterModelName",
+            "Partial",
+            "BRLMChannelResult",
+            "BRLMPrinterSettings"
+          ]
+        }
+      ]
+    },
+    {
+      "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: 'wifi' | 'bluetooth' | 'bluetoothLowEnergy';\n  modelName: string;\n  serialNumber: string;\n  macAddress: string;\n  nodeName: string;\n  location: string;\n  ipAddress: string;\n}",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "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\n  /**\n   * A priority that is print speed or print quality. Whether or not this has an effect is depend on your printer.\n   * note: This is ios only.\n   */\n  resolution?: BRLMPrinterPrintResolution;\n}",
+          "complexTypes": [
+            "BRLMPrinterNumberOfCopies",
+            "BRLMPrinterAutoCutType",
+            "BRLMPrinterScaleMode",
+            "BRLMPrinterScaleValueType",
+            "BRLMPrinterHalftone",
+            "BRLMPrinterHalftoneThresholdType",
+            "BRLMPrinterImageRotation",
+            "BRLMPrinterVerticalAlignment",
+            "BRLMPrinterHorizontalAlignment",
+            "BRLMPrinterCompressMode",
+            "BRLMPrinterPrintQuality",
+            "BRLMPrinterPrintResolution"
+          ]
+        }
+      ]
+    },
+    {
+      "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": "BRLMSearchOption",
+      "slug": "brlmsearchoption",
+      "docs": "",
+      "types": [
+        {
+          "text": "{\n  port: 'wifi' | 'bluetooth' | 'bluetoothLowEnergy';\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": []
+        }
+      ]
+    },
+    {
+      "name": "ErrorInfo",
+      "slug": "errorinfo",
+      "docs": "",
+      "types": [
+        {
+          "text": "{\n  message: string;\n  code: number;\n}",
+          "complexTypes": []
         }
       ]
     }
   ],
-  "enums": [],
-  "typeAliases": [],
   "pluginConfigs": []
 }