Socket
Socket
Sign inDemoInstall

@backstage/plugin-signals

Package Overview
Dependencies
10
Maintainers
3
Versions
159
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@backstage/plugin-signals


Version published
Maintainers
3
Created

Readme

Source

signals

Welcome to the signals plugin!

Signals plugin allows backend plugins to publish messages to frontend plugins.

Getting started

This plugin contains client that can receive messages from the backend. To get started, see installation instructions from @backstage/plugin-signals-node, @backstage/plugin-signals-backend.

To install the plugin, you have to add the following to your packages/app/src/plugins.ts:

export { signalsPlugin } from '@backstage/plugin-signals';

And make sure that your packages/app/src/App.tsx contains:

import * as plugins from './plugins';

const app = createApp({
  // ...
  plugins: Object.values(plugins),
  // ...
});

Now you can utilize the API from other plugins using the @backstage/plugin-signals-react package or simply by:

import { signalApiRef } from '@backstage/plugin-signals-react';

const signals = useApi(signalApiRef);
const { unsubscribe } = signals.subscribe(
  'myplugin:topic',
  (message: JsonObject) => {
    console.log(message);
  },
);
// Remember to unsubscribe
unsubscribe();

FAQs

Last updated on 18 Jun 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc