npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@crx-api/messaging

v1.0.0

Published

chrome浏览器插件通信库。

Downloads

1

Readme

@crx-api/messaging

This package provides two very simple to use classes for sending and receiving plugin communication messages.

Installation

npm install @crx-api/messaging

Usage

In the background script

import { Connect } from '@crx-api/messaging'

const conn = new Connect('my-plugin') // Distinguish the different listeners by specifying a name.
window.conn = conn // Exposed to the "window" object, available for "popup" use.

// debugger log
conn.debugger(msg => {
    // This is an example of how you can customize the style to suit your needs.
    console.log(`%c[DEBUG] ${msg}`, 'background-color: red; color: white; padding: 2px; border-radius: 3px;')
})

// middleware
conn.use('this is a middleware.', (command, payload) => {
    // You can exclude some commands that do not need to execute this middleware by judging "command".
    // "payload" is the parameter carried by the "command" instruction.
    if (command === 'command1') return // The "command1" command will be skipped by the middleware, but will not prevent the execution of this command.
    if (payload.status === 'error') return Error('error message.') // You can also return an error message to stop the execution of the command.
})

// command listener
conn.on('command2', async (payload, callback) => {
    // Do something...
    const res = await doSomething()

    if (res.isError) return callback(Error('error message.')) // You can also return an error message to stop the execution of the command.

    callback(res) // The "command2" command will be executed successfully.
})

// port broadcast
conn.broadcast('IAmReady', { status: 'ok' }) // Broadcast a message to all ports.

In the popup script

// get background's window object
const background = chrome.extension.getBackgroundPage()
const conn = background.conn

// Active trigger command.
conn.emit('command2').then(res => {
    // Do something...
})

In the content script (same as popup script)

import { Port } from '@crx-api/messaging'

const port = new Port('my-plugin') // Distinguish the different listeners by specifying a name.

// broadcast listener
port.on('IAmReady', payload => {
    // Do something...
})

// send command
port.send('command2', { /* some data */ }).then(res => {
    // Do something...
})