Skip to content

Commit 88e5708

Browse files
committed
chore: move explanation to field docstring
1 parent 9abb485 commit 88e5708

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

packages/event-handler/src/types/appsync-events.ts

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,12 @@ type RouteOptions<T extends boolean | undefined = false> = {
162162
// #region Events
163163

164164
type AppSyncEventsEvent = {
165+
/**
166+
* The `identity` field is marked as `unknown` because it varies based on the authentication type used in AppSync.
167+
* When using an API key, it will be `null`. When using IAM, it will contain the AWS credentials of the user. When using Cognito,
168+
* it will contain the Cognito user pool information. When using a Lambda authorizer, it will contain the information returned
169+
* by the authorizer.
170+
*/
165171
identity: unknown;
166172
result: null;
167173
request: {
@@ -188,11 +194,6 @@ type AppSyncEventsEvent = {
188194
/**
189195
* Event type for AppSync Events publish events.
190196
*
191-
* The `identity` field is marked as `unknown` because it varies based on the authentication type used in AppSync.
192-
* When using an API key, it will be `null`. When using IAM, it will contain the AWS credentials of the user. When using Cognito,
193-
* it will contain the Cognito user pool information. When using a Lambda authorizer, it will contain the information returned
194-
* by the authorizer.
195-
*
196197
* @example
197198
* ```json
198199
* {
@@ -248,11 +249,6 @@ type AppSyncEventsPublishEvent = AppSyncEventsEvent & {
248249
/**
249250
* Event type for AppSync Events subscribe events.
250251
*
251-
* The `identity` field is marked as `unknown` because it varies based on the authentication type used in AppSync.
252-
* When using an API key, it will be `null`. When using IAM, it will contain the AWS credentials of the user. When using Cognito,
253-
* it will contain the Cognito user pool information. When using a Lambda authorizer, it will contain the information returned
254-
* by the authorizer.
255-
*
256252
* @example
257253
* ```json
258254
* {

0 commit comments

Comments
 (0)