Skip to content

Commit 9beb6fe

Browse files
committed
Another docs pass (typos and hunting down remaining wills)
1 parent 249707a commit 9beb6fe

File tree

3 files changed

+7
-8
lines changed

3 files changed

+7
-8
lines changed

src/eventarc/cloudevent.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export interface CloudEvent {
8282
time?: string;
8383

8484
/**
85-
* Data payload of the event. Objects are strigified with JSON and strings are be passed along as-is.
85+
* Data payload of the event. Objects are stringified with JSON and strings are be passed along as-is.
8686
*/
8787
data?: object | string;
8888

src/eventarc/eventarc-client-internal.ts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,15 +73,14 @@ export class EventarcApiClient {
7373
}
7474

7575
/**
76-
* Publishes provided events to this channel. If channel was created with
77-
* `allowedEventsTypes` and event type is not on that list, the event will
78-
* be ignored.
76+
* Publishes provided events to this channel. If channel was created with `allowedEventsTypes` and event type
77+
* is not on that list, the event is ignored.
7978
*
80-
* The following CloudEvent fields will be auto-populated if not set:
79+
* The following CloudEvent fields are auto-populated if not set:
8180
* * specversion - `1.0`
8281
* * id - uuidv4()
83-
* * source - will be populated with `process.env.EVENTARC_CLOUD_EVENT_SOURCE` and
84-
* if not set an error will be thrown.
82+
* * source - populated with `process.env.EVENTARC_CLOUD_EVENT_SOURCE` and
83+
* if not set an error is thrown.
8584
*
8685
* @param events - CloudEvent to publish to the channel.
8786
*/

src/eventarc/eventarc-utils.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ export function toCloudEventProtoFormat(ce: CloudEvent): any {
110110
} else {
111111
throw new FirebaseEventarcError(
112112
'invalid-argument',
113-
`CloudEvent 'data' must be string or an object (which will be converted to JSON), got '${typeof ce.data}'.`);
113+
`CloudEvent 'data' must be string or an object (which are converted to JSON), got '${typeof ce.data}'.`);
114114
}
115115

116116
for (const attr in ce) {

0 commit comments

Comments
 (0)