File

lib/shared/modules/ms-client/ms-client.types.ts

Description

Interface defining the contract for the message bus.

Index

Methods

Methods

dispatch
dispatch(pattern: any, data?: TInput, opts?: MsClientOptions)
Type parameters :
  • TResult
  • TInput
Parameters :
Name Type Optional
pattern any No
data TInput Yes
opts MsClientOptions Yes
Returns : Promise<TResult>
emit
emit(pattern: any, data?: TInput, opts?: MsClientOptions)
Type parameters :
  • TResult
  • TInput
Parameters :
Name Type Optional
pattern any No
data TInput Yes
opts MsClientOptions Yes
Returns : Observable<TResult>
send
send(pattern: any, data?: TInput, opts?: MsClientOptions)
Type parameters :
  • TResult
  • TInput
Parameters :
Name Type Optional
pattern any No
data TInput Yes
opts MsClientOptions Yes
Returns : Observable<TResult>
import { Observable } from "rxjs";

/**
 * Type definition for microservices client options.
 */
export type MsClientOptions = {
  timeout: number;
};

/**
 * Interface defining the contract for the message bus.
 */
export interface MessageBus {
  dispatch<TResult = any, TInput = any>(
    pattern: any,
    data?: TInput,
    opts?: MsClientOptions,
  ): Promise<TResult>;

  send<TResult = any, TInput = any>(
    pattern: any,
    data?: TInput,
    opts?: MsClientOptions,
  ): Observable<TResult>;

  emit<TResult = any, TInput = any>(
    pattern: any,
    data?: TInput,
    opts?: MsClientOptions,
  ): Observable<TResult>;
}

results matching ""

    No results matching ""