https://github.com/hcfyapp/chrome-call

Call the original chrome javascript API and return a Promise.
https://github.com/hcfyapp/chrome-call

chrome-api chrome-app chrome-extension es6 promise

Last synced: 3 months ago
JSON representation

Call the original chrome javascript API and return a Promise.

• Host: GitHub
• URL: https://github.com/hcfyapp/chrome-call
• Owner: hcfyapp
• Archived: true
• Created: 2016-01-04T06:55:19.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-08-27T19:28:05.000Z (over 6 years ago)
• Last Synced: 2024-11-01T21:36:19.898Z (3 months ago)
• Topics: chrome-api, chrome-app, chrome-extension, es6, promise
• Language: TypeScript
• Homepage:
• Size: 117 KB
• Stars: 21
• Watchers: 4
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# chrome-call [![Build Status](https://img.shields.io/travis/Selection-Translator/chrome-call/master.svg?style=flat-square)](https://travis-ci.org/Selection-Translator/chrome-call) [![Coverage Status](https://img.shields.io/coveralls/Selection-Translator/chrome-call/master.svg?style=flat-square)](https://coveralls.io/github/Selection-Translator/chrome-call?branch=master) [![NPM Version](https://img.shields.io/npm/v/chrome-call.svg?style=flat-square)](https://www.npmjs.com/package/chrome-call)

Call the [Chrome JavasScript APIs](https://developer.chrome.com/extensions/api_index) 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:

```js

// es6

import chromeCall from 'chrome-call'

// commonjs

const chromeCall = require('chrome-call')

```

### Use with <script>

Download chrome-call.js from [unpkg](https://unpkg.com/chrome-call)([min version](https://unpkg.com/chrome-call/dist/chrome-call.min.js)), then reference it in your html:

```html

  typeof chromeCall // function

```

## Usage

When you do:

```js

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:

```js

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](https://developer.chrome.com/apps/hid#method-receive).

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

```js

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