Skip to content

Commit 11d35b3

Browse files
refactor!: rename cloudevent to CloudEvent (#379)
This commit is a refactor of all our cloudevent identifiers to be more consistent. Depending on the context we will always prefer: `CloudEvent`, `cloudEvent`, or `cloud_event`. We will avoid `cloudevent` Fixes #378
1 parent 292ade9 commit 11d35b3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+78
-78
lines changed

docs/generated/api.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,25 @@ import * as express from 'express';
55
/**
66
* Register a function that handles CloudEvents.
77
* @param functionName - the name of the function
8-
* @param handler - the function to trigger when handling cloudevents
8+
* @param handler - the function to trigger when handling CloudEvents
99
* @public
1010
*/
11-
export declare const cloudevent: (functionName: string, handler: CloudEventFunction) => void;
11+
export declare const cloudEvent: (functionName: string, handler: CloudEventFunction) => void;
1212

1313
/**
14-
* A cloudevent function handler.
14+
* A CloudEvent function handler.
1515
* @public
1616
*/
1717
export declare interface CloudEventFunction {
18-
(cloudevent: CloudEventsContext): any;
18+
(cloudEvent: CloudEventsContext): any;
1919
}
2020

2121
/**
22-
* A cloudevent function handler with callback.
22+
* A CloudEvent function handler with callback.
2323
* @public
2424
*/
2525
export declare interface CloudEventFunctionWithCallback {
26-
(cloudevent: CloudEventsContext, callback: Function): any;
26+
(cloudEvent: CloudEventsContext, callback: Function): any;
2727
}
2828

2929
/**

docs/generated/api.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -171,12 +171,12 @@
171171
"members": [
172172
{
173173
"kind": "Variable",
174-
"canonicalReference": "@google-cloud/functions-framework!cloudevent:var",
175-
"docComment": "/**\n * Register a function that handles CloudEvents.\n *\n * @param functionName - the name of the function\n *\n * @param handler - the function to trigger when handling cloudevents\n *\n * @public\n */\n",
174+
"canonicalReference": "@google-cloud/functions-framework!cloudEvent:var",
175+
"docComment": "/**\n * Register a function that handles CloudEvents.\n *\n * @param functionName - the name of the function\n *\n * @param handler - the function to trigger when handling CloudEvents\n *\n * @public\n */\n",
176176
"excerptTokens": [
177177
{
178178
"kind": "Content",
179-
"text": "cloudevent: "
179+
"text": "cloudEvent: "
180180
},
181181
{
182182
"kind": "Content",
@@ -193,7 +193,7 @@
193193
}
194194
],
195195
"releaseTag": "Public",
196-
"name": "cloudevent",
196+
"name": "cloudEvent",
197197
"variableTypeTokenRange": {
198198
"startIndex": 1,
199199
"endIndex": 4
@@ -202,7 +202,7 @@
202202
{
203203
"kind": "Interface",
204204
"canonicalReference": "@google-cloud/functions-framework!CloudEventFunction:interface",
205-
"docComment": "/**\n * A cloudevent function handler.\n *\n * @public\n */\n",
205+
"docComment": "/**\n * A CloudEvent function handler.\n *\n * @public\n */\n",
206206
"excerptTokens": [
207207
{
208208
"kind": "Content",
@@ -219,7 +219,7 @@
219219
"excerptTokens": [
220220
{
221221
"kind": "Content",
222-
"text": "(cloudevent: "
222+
"text": "(cloudEvent: "
223223
},
224224
{
225225
"kind": "Reference",
@@ -247,7 +247,7 @@
247247
"overloadIndex": 1,
248248
"parameters": [
249249
{
250-
"parameterName": "cloudevent",
250+
"parameterName": "cloudEvent",
251251
"parameterTypeTokenRange": {
252252
"startIndex": 1,
253253
"endIndex": 2
@@ -261,7 +261,7 @@
261261
{
262262
"kind": "Interface",
263263
"canonicalReference": "@google-cloud/functions-framework!CloudEventFunctionWithCallback:interface",
264-
"docComment": "/**\n * A cloudevent function handler with callback.\n *\n * @public\n */\n",
264+
"docComment": "/**\n * A CloudEvent function handler with callback.\n *\n * @public\n */\n",
265265
"excerptTokens": [
266266
{
267267
"kind": "Content",
@@ -278,7 +278,7 @@
278278
"excerptTokens": [
279279
{
280280
"kind": "Content",
281-
"text": "(cloudevent: "
281+
"text": "(cloudEvent: "
282282
},
283283
{
284284
"kind": "Reference",
@@ -315,7 +315,7 @@
315315
"overloadIndex": 1,
316316
"parameters": [
317317
{
318-
"parameterName": "cloudevent",
318+
"parameterName": "cloudEvent",
319319
"parameterTypeTokenRange": {
320320
"startIndex": 1,
321321
"endIndex": 2

docs/generated/api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@
99
import * as express from 'express';
1010

1111
// @public
12-
export const cloudevent: (functionName: string, handler: CloudEventFunction) => void;
12+
export const cloudEvent: (functionName: string, handler: CloudEventFunction) => void;
1313

1414
// @public
1515
export interface CloudEventFunction {
1616
// (undocumented)
17-
(cloudevent: CloudEventsContext): any;
17+
(cloudEvent: CloudEventsContext): any;
1818
}
1919

2020
// @public
2121
export interface CloudEventFunctionWithCallback {
2222
// (undocumented)
23-
(cloudevent: CloudEventsContext, callback: Function): any;
23+
(cloudEvent: CloudEventsContext, callback: Function): any;
2424
}
2525

2626
// @public

0 commit comments

Comments
 (0)