From 92f14f8d5217856504b0208e2ba73ec3435e4b37 Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Thu, 18 May 2017 10:14:55 -0700 Subject: [PATCH] printerList() -> getPrinters() --- atom/browser/api/atom_api_web_contents.cc | 8 +-- docs/api/web-contents.md | 64 ++++++++++++----------- spec/api-browser-window-spec.js | 4 +- 3 files changed, 39 insertions(+), 37 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 3aba1babef54..56a3ab3d90e2 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -143,9 +143,9 @@ struct Converter { static v8::Local ToV8(v8::Isolate* isolate, const printing::PrinterBasicInfo& val) { mate::Dictionary dict(isolate, v8::Object::New(isolate)); - dict.Set("printerName", val.printer_name); - dict.Set("printerDescription", val.printer_description); - dict.Set("printerStatus", val.printer_status); + dict.Set("name", val.printer_name); + dict.Set("description", val.printer_description); + dict.Set("status", val.printer_status); dict.Set("isDefault", val.is_default); dict.Set("options", val.options); return dict.GetHandle(); @@ -1872,7 +1872,7 @@ void WebContents::BuildPrototype(v8::Isolate* isolate, &WebContents::UnregisterServiceWorker) .SetMethod("inspectServiceWorker", &WebContents::InspectServiceWorker) .SetMethod("print", &WebContents::Print) - .SetMethod("printerList", &WebContents::GetPrinterList) + .SetMethod("getPrinters", &WebContents::GetPrinterList) .SetMethod("_printToPDF", &WebContents::PrintToPDF) .SetMethod("addWorkSpace", &WebContents::AddWorkSpace) .SetMethod("removeWorkSpace", &WebContents::RemoveWorkSpace) diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 15f0ebe66467..b0a1253aa9e3 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -916,39 +916,41 @@ Unregisters any ServiceWorker if present and returns a boolean as response to `callback` when the JS promise is fulfilled or false when the JS promise is rejected. -#### `contents.printerList()` +#### `contents.getPrinters()` -Get the system printer list, the result is an array of printer description. -eg: -````js -[{ printerName: 'Zebra_LP2844', - printerDescription: 'Zebra LP2844', - printerStatus: 3, - isDefault: 0, - options: - { copies: '1', - 'device-uri': 'usb://Zebra/LP2844?location=14200000', - finishings: '3', - 'job-cancel-after': '10800', - 'job-hold-until': 'no-hold', - 'job-priority': '50', - 'job-sheets': 'none,none', - 'marker-change-time': '0', - 'number-up': '1', - 'printer-commands': 'none', - 'printer-info': 'Zebra LP2844', - 'printer-is-accepting-jobs': 'true', - 'printer-is-shared': 'true', - 'printer-location': '', - 'printer-make-and-model': 'Zebra EPL2 Label Printer', - 'printer-state': '3', - 'printer-state-change-time': '1484872644', - 'printer-state-reasons': 'offline-report', - 'printer-type': '36932', - 'printer-uri-supported': 'ipp://localhost/printers/Zebra_LP2844', - system_driverinfo: 'Z' } }] -```` +Get the system printer list, the result is an array of printer descriptions. +```js +[{ + name: 'Zebra_LP2844', + description: 'Zebra LP2844', + status: 3, + isDefault: 0, + options: { + copies: '1', + 'device-uri': 'usb://Zebra/LP2844?location=14200000', + finishings: '3', + 'job-cancel-after': '10800', + 'job-hold-until': 'no-hold', + 'job-priority': '50', + 'job-sheets': 'none,none', + 'marker-change-time': '0', + 'number-up': '1', + 'printer-commands': 'none', + 'printer-info': 'Zebra LP2844', + 'printer-is-accepting-jobs': 'true', + 'printer-is-shared': 'true', + 'printer-location': '', + 'printer-make-and-model': 'Zebra EPL2 Label Printer', + 'printer-state': '3', + 'printer-state-change-time': '1484872644', + 'printer-state-reasons': 'offline-report', + 'printer-type': '36932', + 'printer-uri-supported': 'ipp://localhost/printers/Zebra_LP2844', + system_driverinfo: 'Z' + } +}] +``` #### `contents.print([options])` diff --git a/spec/api-browser-window-spec.js b/spec/api-browser-window-spec.js index 70ed7ae3aa8f..6c54731aa70f 100644 --- a/spec/api-browser-window-spec.js +++ b/spec/api-browser-window-spec.js @@ -1125,8 +1125,8 @@ describe('BrowserWindow module', function () { }) w.loadURL('data:text/html,%3Ch1%3EHello%2C%20World!%3C%2Fh1%3E') w.webContents.once('did-finish-load', function () { - const pl = w.webContents.printerList() - assert.equal(Array.isArray(pl), true) + const printers = w.webContents.getPrinters() + assert.equal(Array.isArray(printers), true) done() }) })