chore: signal type naming
Signed-off-by: Heikki Hellgren <heikki.hellgren@op.fi>
This commit is contained in:
@@ -28,8 +28,8 @@ export interface SignalSubscriber {
|
||||
|
||||
/** @public */
|
||||
export interface SignalApi {
|
||||
subscribe<SignalType extends JsonObject = JsonObject>(
|
||||
subscribe<TMessage extends JsonObject = JsonObject>(
|
||||
channel: string,
|
||||
onMessage: (message: SignalType) => void,
|
||||
onMessage: (message: TMessage) => void,
|
||||
): SignalSubscriber;
|
||||
}
|
||||
|
||||
@@ -19,20 +19,20 @@ import { JsonObject } from '@backstage/types';
|
||||
import { useEffect, useMemo, useState } from 'react';
|
||||
|
||||
/** @public */
|
||||
export const useSignal = <SignalType extends JsonObject = JsonObject>(
|
||||
export const useSignal = <TMessage extends JsonObject = JsonObject>(
|
||||
channel: string,
|
||||
): { lastSignal: SignalType | null; isSignalsAvailable: boolean } => {
|
||||
): { lastSignal: TMessage | null; isSignalsAvailable: boolean } => {
|
||||
const apiHolder = useApiHolder();
|
||||
// Use apiHolder instead useApi in case signalApi is not available in the
|
||||
// backstage instance this is used
|
||||
const signals = apiHolder.get(signalApiRef);
|
||||
const [lastSignal, setLastSignal] = useState<SignalType | null>(null);
|
||||
const [lastSignal, setLastSignal] = useState<TMessage | null>(null);
|
||||
useEffect(() => {
|
||||
let unsub: null | (() => void) = null;
|
||||
if (signals) {
|
||||
const { unsubscribe } = signals.subscribe<SignalType>(
|
||||
const { unsubscribe } = signals.subscribe<TMessage>(
|
||||
channel,
|
||||
(msg: SignalType) => {
|
||||
(msg: TMessage) => {
|
||||
setLastSignal(msg);
|
||||
},
|
||||
);
|
||||
|
||||
Reference in New Issue
Block a user