Skip to content

Commit e8034d0

Browse files
committed
updating descriptions for event notification arguments
1 parent b4dfda4 commit e8034d0

File tree

3 files changed

+13
-14
lines changed

3 files changed

+13
-14
lines changed

.changeset/blue-bags-walk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
"wrangler": minor
2+
"wrangler": patch
33
---
44

55
fix: making explicit to only send a body if there are rule ids specified in the config delete

packages/wrangler/src/__tests__/r2.test.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1021,10 +1021,10 @@ describe("r2", () => {
10211021
-v, --version Show version number [boolean]
10221022
10231023
OPTIONS
1024-
--event-types, --event-type Specify the kinds of object events to emit notifications for. ex. '--event-types object-create object-delete' [array] [required] [choices: \\"object-create\\", \\"object-delete\\"]
1025-
--prefix only actions on objects with this prefix will emit notifications [string]
1026-
--suffix only actions on objects with this suffix will emit notifications [string]
1027-
--queue The name of the queue to which event notifications will be sent. ex '--queue my-queue' [string] [required]"
1024+
--event-types, --event-type The type of event(s) that will emit event notifications [array] [required] [choices: \\"object-create\\", \\"object-delete\\"]
1025+
--prefix The prefix that an object must match to emit event notifications (note: regular expressions not supported) [string]
1026+
--suffix The suffix that an object must match to emit event notifications (note: regular expressions not supported) [string]
1027+
--queue The name of the queue that will receive event notification messages [string] [required]"
10281028
`);
10291029
});
10301030
});
@@ -1178,8 +1178,8 @@ describe("r2", () => {
11781178
-v, --version Show version number [boolean]
11791179
11801180
OPTIONS
1181-
--queue The name of the queue that is configured to receive notifications. ex '--queue my-queue' [string] [required]
1182-
--rule The id of the rule to delete. If no rule is specified, all rules for the bucket/queue configuration will be deleted. [string]"
1181+
--queue The name of the queue that will receive event notification messages [string] [required]
1182+
--rule The id of the rule to delete. If no rule is specified, all rules for the bucket/queue configuration will be deleted [string]"
11831183
`);
11841184
});
11851185
});

packages/wrangler/src/r2/notification.ts

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,7 @@ export function CreateOptions(yargs: CommonYargsArgv) {
4949
demandOption: true,
5050
})
5151
.option("event-types", {
52-
describe:
53-
"Specify the kinds of object events to emit notifications for. ex. '--event-types object-create object-delete'",
52+
describe: "The type of event(s) that will emit event notifications",
5453
alias: "event-type",
5554
choices: Object.keys(actionsForEventCategories),
5655
demandOption: true,
@@ -59,18 +58,18 @@ export function CreateOptions(yargs: CommonYargsArgv) {
5958
})
6059
.option("prefix", {
6160
describe:
62-
"only actions on objects with this prefix will emit notifications",
61+
"The prefix that an object must match to emit event notifications (note: regular expressions not supported)",
6362
requiresArg: false,
6463
type: "string",
6564
})
6665
.option("suffix", {
6766
describe:
68-
"only actions on objects with this suffix will emit notifications",
67+
"The suffix that an object must match to emit event notifications (note: regular expressions not supported)",
6968
type: "string",
7069
})
7170
.option("queue", {
7271
describe:
73-
"The name of the queue to which event notifications will be sent. ex '--queue my-queue'",
72+
"The name of the queue that will receive event notification messages",
7473
demandOption: true,
7574
requiresArg: true,
7675
type: "string",
@@ -108,14 +107,14 @@ export function DeleteOptions(yargs: CommonYargsArgv) {
108107
})
109108
.option("queue", {
110109
describe:
111-
"The name of the queue that is configured to receive notifications. ex '--queue my-queue'",
110+
"The name of the queue that will receive event notification messages",
112111
demandOption: true,
113112
requiresArg: true,
114113
type: "string",
115114
})
116115
.option("rule", {
117116
describe:
118-
"The id of the rule to delete. If no rule is specified, all rules for the bucket/queue configuration will be deleted.",
117+
"The id of the rule to delete. If no rule is specified, all rules for the bucket/queue configuration will be deleted",
119118
requiresArg: false,
120119
type: "string",
121120
});

0 commit comments

Comments
 (0)