chore: signal type naming

Signed-off-by: Heikki Hellgren <heikki.hellgren@op.fi>
This commit is contained in:
Heikki Hellgren
2024-02-12 15:28:41 +02:00
parent 1bbb0471d0
commit ca8081166b
9 changed files with 26 additions and 26 deletions
+5 -5
View File
@@ -11,8 +11,8 @@ import { ServiceRef } from '@backstage/backend-plugin-api';
export class DefaultSignalService implements SignalService {
// (undocumented)
static create(options: SignalServiceOptions): DefaultSignalService;
publish<SignalType extends JsonObject = JsonObject>(
signal: SignalPayload<SignalType>,
publish<TMessage extends JsonObject = JsonObject>(
signal: SignalPayload<TMessage>,
): Promise<void>;
}
@@ -20,13 +20,13 @@ export class DefaultSignalService implements SignalService {
export type SignalPayload<TMessage extends JsonObject = JsonObject> = {
recipients: string[] | string | null;
channel: string;
message: SignalType;
message: TMessage;
};
// @public (undocumented)
export interface SignalService {
publish<SignalType extends JsonObject = JsonObject>(
signal: SignalPayload<SignalType>,
publish<TMessage extends JsonObject = JsonObject>(
signal: SignalPayload<TMessage>,
): Promise<void>;
}
@@ -35,8 +35,8 @@ export class DefaultSignalService implements SignalService {
* Publishes a signal to user refs to specific topic
* @param signal - Signal to publish
*/
async publish<SignalType extends JsonObject = JsonObject>(
signal: SignalPayload<SignalType>,
async publish<TMessage extends JsonObject = JsonObject>(
signal: SignalPayload<TMessage>,
) {
await this.eventBroker?.publish({
topic: 'signals',
+2 -2
View File
@@ -22,7 +22,7 @@ export interface SignalService {
* Publishes a signal to user refs to specific topic
* @param signal - Signal to publish
*/
publish<SignalType extends JsonObject = JsonObject>(
signal: SignalPayload<SignalType>,
publish<TMessage extends JsonObject = JsonObject>(
signal: SignalPayload<TMessage>,
): Promise<void>;
}
+2 -2
View File
@@ -24,8 +24,8 @@ export type SignalServiceOptions = {
};
/** @public */
export type SignalPayload<SignalType extends JsonObject = JsonObject> = {
export type SignalPayload<TMessage extends JsonObject = JsonObject> = {
recipients: string[] | string | null;
channel: string;
message: SignalType;
message: TMessage;
};