Skip to content
This repository has been archived by the owner on Nov 18, 2021. It is now read-only.
/ chrome-call Public archive

Call the original chrome javascript API and return a Promise.

Notifications You must be signed in to change notification settings

hcfyapp/chrome-call

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

chrome-call Build Status Coverage Status NPM Version

Call the Chrome JavasScript APIs then return a Promise.

Install

Use with webpack

If you build your project with webpack, then you can install chrome-call from npm:

npm install chrome-call

then you can import it in your project:

// es6
import chromeCall from 'chrome-call'

// commonjs
const chromeCall = require('chrome-call')

Use with <script>

Download chrome-call.js from unpkg(min version), then reference it in your html:

<script src="path/to/chrome-call.js"></script>
<!-- now you will get a global variable named chromeCall -->
<script>
  typeof chromeCall // function
</script>

Usage

When you do:

const promise = new Promise((resolve, reject) => {
  chrome.tabs.sendMessage(tabId, message, options, response => {
    if (chrome.runtime.lastError) {
      reject(chrome.runtime.lastError)
    } else {
      resolve(response)
    }
  })
})

It's equal to:

const promise = chromeCall(chrome.tabs, 'sendMessage', tabId, message, options)

That's really simple, right?

Multiple arguments in callback

Most of chrome API only has zero or one argument in callback, but someone not, such as chrome.hid.receive.

In this situation, pass true as the first argument, then the value of promise will be an real Array:

import chromeCall from 'chrome-call'

chromeCall(true, chrome.hid, 'receive', connectionId).then(args => {
  Array.isArray(args) // true
  const reportId = args[0]
  const data = args[1]
})

License

MIT