Skip to content

Commit faff7a1

Browse files
docs(chore): docs update
docs update BREAKING CHANGE: YES GH-99
1 parent f8e9dfb commit faff7a1

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/decorators/consumer.decorator.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@ import {Constructor, injectable} from '@loopback/core';
22
import {asConsumer} from '../keys';
33
import {IConsumer, IStreamDefinition} from '../types';
44

5+
/**
6+
* The `consumer` function in TypeScript is a generic function that returns an injectable consumer for
7+
* a specific stream definition and message type.
8+
* @returns The `consumer` function is returning a function that takes a target constructor of type
9+
* `IConsumer<T, E>` and does some operation on it. The specific operation being performed is not clear
10+
* from the provided code snippet.
11+
*/
512
export function consumer<
613
T extends IStreamDefinition,
714
E extends keyof T['messages'],

0 commit comments

Comments
 (0)