docs(resolvers): added better explanation about callbackWaitsForEmpty…

…EventLoop
H4ad · Feb 28, 2022 · ff20236 · ff20236
1 parent b31f153
commit ff20236
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/src/v2/resolvers/aws-context.resolver.ts b/src/v2/resolvers/aws-context.resolver.ts
@@ -11,9 +11,11 @@ import {
 //#endregion
 
 /**
- * The class that implements the resolver by using the AWS Context object
+ * The class that implements the resolver by using the AWS Context object.
  *
- * @note```md
+ * @note To use this resolver, you MUST leave `{@link https://docs.aws.amazon.com/lambda/latest/dg/nodejs-context.html callbackWaitsForEmptyEventLoop}` as true, otherwise, AWS will not wait for this resolver to resolve.
+ *
+ * ```md
  * From the AWS Documentation, describing the functions used in this resolver:
  * // Functions for compatibility with earlier Node.js Runtime v0.10.42
  * // No longer documented, so they are deprecated, but they still work

diff --git a/src/v2/resolvers/callback.resolver.ts b/src/v2/resolvers/callback.resolver.ts
@@ -19,6 +19,8 @@ export type ServerlessCallback<TResponse> = (
 
 /**
  * The class that implements the resolver using the callback function sent by serverless
+ *
+ * @note To use this resolver on AWS, you MUST leave `{@link https://docs.aws.amazon.com/lambda/latest/dg/nodejs-context.html callbackWaitsForEmptyEventLoop}` as true, otherwise, AWS will not wait for this resolver to resolve.
  */
 export class CallbackResolver
   implements ResolverContract<any, any, ServerlessCallback<any>, any>