Skip to content

Commit da81dc2

Browse files
committed
Extract API doc and remove hyperlink due to duplicate names from function overload
1 parent cf2163d commit da81dc2

3 files changed

Lines changed: 15 additions & 4 deletions

File tree

etc/firebase-admin.api.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -376,6 +376,8 @@ export namespace messaging {
376376
export type FcmOptions = FcmOptions;
377377
// Warning: (ae-forgotten-export) The symbol "FidMessage" needs to be exported by the entry point default-namespace.d.ts
378378
export type FidMessage = FidMessage;
379+
// Warning: (ae-forgotten-export) The symbol "FidMulticastMessage" needs to be exported by the entry point default-namespace.d.ts
380+
export type FidMulticastMessage = FidMulticastMessage;
379381
// Warning: (ae-forgotten-export) The symbol "LightSettings" needs to be exported by the entry point default-namespace.d.ts
380382
export type LightSettings = LightSettings;
381383
// Warning: (ae-forgotten-export) The symbol "Message" needs to be exported by the entry point default-namespace.d.ts
@@ -389,6 +391,8 @@ export namespace messaging {
389391
// Warning: (ae-forgotten-export) The symbol "MessagingTopicManagementResponse" needs to be exported by the entry point default-namespace.d.ts
390392
export type MessagingTopicManagementResponse = MessagingTopicManagementResponse;
391393
// Warning: (ae-forgotten-export) The symbol "MulticastMessage" needs to be exported by the entry point default-namespace.d.ts
394+
//
395+
// @deprecated
392396
export type MulticastMessage = MulticastMessage;
393397
// Warning: (ae-forgotten-export) The symbol "Notification" needs to be exported by the entry point default-namespace.d.ts
394398
export type Notification = Notification;

etc/firebase-admin.messaging.api.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,11 @@ export interface FidMessage extends BaseMessage {
173173
fid: string;
174174
}
175175

176+
// @public
177+
export interface FidMulticastMessage extends BaseMessage {
178+
fids: string[];
179+
}
180+
176181
// Warning: (ae-forgotten-export) The symbol "PrefixedFirebaseError" needs to be exported by the entry point index.d.ts
177182
//
178183
// @public
@@ -201,7 +206,9 @@ export class Messaging {
201206
enableLegacyHttpTransport(): void;
202207
send(message: Message, dryRun?: boolean): Promise<string>;
203208
sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
209+
// @deprecated
204210
sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
211+
sendEachForMulticast(message: FidMulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
205212
subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
206213
unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
207214
}
@@ -332,7 +339,7 @@ export interface MessagingTopicManagementResponse {
332339
successCount: number;
333340
}
334341

335-
// @public
342+
// @public @deprecated
336343
export interface MulticastMessage extends BaseMessage {
337344
fids?: string[];
338345
// @deprecated

src/messaging/messaging-api.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ export interface ConditionMessage extends BaseMessage {
5858
export type Message = FidMessage | TokenMessage | TopicMessage | ConditionMessage;
5959

6060
/**
61-
* Payload for the {@link Messaging.sendEachForMulticast} method.
61+
* Payload for the `sendEachForMulticast` method.
6262
*
6363
* @deprecated Use {@link FidMulticastMessage} instead.
6464
*/
@@ -76,7 +76,7 @@ export interface MulticastMessage extends BaseMessage {
7676
}
7777

7878
/**
79-
* Payload for the {@link Messaging.sendEachForMulticast} method containing only FIDs.
79+
* Payload for the `sendEachForMulticast` method containing only FIDs.
8080
*/
8181
export interface FidMulticastMessage extends BaseMessage {
8282
/**
@@ -1034,7 +1034,7 @@ export interface MessagingTopicManagementResponse {
10341034

10351035
/**
10361036
* Interface representing the server response from the
1037-
* {@link Messaging.sendEach} and {@link Messaging.sendEachForMulticast} methods.
1037+
* {@link Messaging.sendEach} and `sendEachForMulticast` methods.
10381038
*/
10391039
export interface BatchResponse {
10401040

0 commit comments

Comments
 (0)