acvetkov / then-chrome Goto Github PK

37.0 3.0 7.0 40 KB

Promise-based chrome-api

JavaScript 100.00%

then-chrome's Introduction

then-chrome

Promise-based chrome api.

usage

var thenChrome = require('then-chrome');

// get tabs list
thenChrome.tabs.query({currentWindow: true})
   .then(console.log); // tabs list

// get all cookies by name   
thenChrome.cookies.getAll({name: 'cookieName'})
   .then(console.log); // cookie list
   
// detect language by tab
thenChrome.tabs.detectLanguage(10)
   .then(console.log); // en
   .catch(console.warn); // catch chrome.runtime.lastError value

Sync methods are wrapped too

var thenChrome = require('then-chrome');

thenChrome.i18n.getMessage('title')
   .then(console.log); // 'extension title'

There is native Promise inside then-chrome by default, but you can use every Thenable lib, compatible with Promises/A+ standart.

var Q = require('q');
var BlueBird = require('bluebird');
var create = require('then-chrome/out/api');

var thenChromeQ = create(Q.Promise); // then-chrome with Q promise inside
var thenChromeBB = create(BlueBird); // then-chrome with bluebird promise inside

install

npm install then-chrome

git clone https://github.com/acvetkov/then-chrome.git
cd then-chrome
npm install

build

npm run build

test

npm test

Supported methods

chrome.alarms
chrome.bookmarks
chrome.browserAction
chrome.browsingData
chrome.commands
chrome.contextMenus
chrome.cookies
chrome.debugger
chrome.desktopCapture
chrome.devtools.inspectedWindow
chrome.devtools.network
chrome.devtools.panels
chrome.dial (undocumented API for communication with DIAL-capable devices)
chrome.downloads
chrome.extension
chrome.fontSettings
chrome.gcm
chrome.history
chrome.i18n
chrome.identity
chrome.idle
chrome.instanceID
chrome.management
chrome.notifications
chrome.omnibox
chrome.pageAction
chrome.pageCapture
chrome.permissions
chrome.privacy
chrome.proxy
chrome.runtime
chrome.sessions
chrome.storage
chrome.system.cpu
chrome.system.memory
chrome.system.storage
chrome.tabCapture
chrome.tabs
chrome.topSites
chrome.tts
chrome.webNavigation
chrome.webRequest
chrome.windows

Useful resources

Awesome Browser Extensions And Apps - a curated list of awesome resources for building browser extensions and apps.

then-chrome's People

Contributors

Stargazers

Watchers

Forkers

iliabv vitalets chanand pastak aleksandr-oleynikov ace53thntu k-timoshenko

then-chrome's Issues

usage example?

Append lazy getters for methods

Chrome api object is rather big, it takes unnecessary memory for unused methods.
It will be very good to generate promise wrappers by access to them by getters.

For example:

Object.defineProperty(chromeApi.tabs, 'query', {
   get: function() {
      return wrapMethod(chrome.tabs, 'query');
   }
});

Use native chrome promises?

Is it possible to use native chrome promises instead of q ?

Support *.sendMessage methods

chrome.runtime.sendMessage and chrome.tabs.sendMessage methods are not supports.
It will be great wrap it methods to Promise call, which resolves with sendResponse function.

import thenChrome from 'then-chrome';

thenChrome.runtime.sendMessage(message, options)
   .then(response => console.log(response))
   .catch(err => console.error(err));

// equals to

chrome.runtime.sendMessage(message, options, response => {
   if (chrome.runtime.lastError) {
      console.error(chrome.runtime.lastError);
   } else {
      console.log(response);
   }
});

Support chrome.proxy.settings

chrome.proxy.settings is not supported, so there is no way to get a then-promise for:

chrome.proxy.settings.get
chrome.proxy.settings.set
chrome.proxy.settings.clear

Proxy event channels to thenChrome also (for consistency)

Currently event channels are not in then-chrome.
So I can not write:

thenChrome.alarms.create('alarm');
thenChrome.alarms.onAlarm.addListener(listener);

It gets error:

Uncaught TypeError: Cannot read property 'addListener' of undefined

I need to write:

thenChrome.alarms.create('alarm');
chrome.alarms.onAlarm.addListener(listener);

that looks less consistent.

It would be nice if event channels (like alarms.onAlarm and etc) will be proxied to thenChrome object.

Getting error while calling any method

Hi,

I'm getting error when calling any method like tabs, windows etc.
Ex: I'm calling

chrome.tabs.query({}, function(res){
            console.log(res);
          })

I'm getting error.

Uncaught (in promise): TypeError: Cannot read property 'query' of null

Please help... Thanks in advance