@zuplo/graphql 5.1796.0 → 5.1797.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -449,7 +449,17 @@ declare enum HttpStatusCode {
449
449
  declare type HttpStatusCodeRangeDefinition = "1XX" | "2XX" | "3XX" | "4XX" | "5XX";
450
450
 
451
451
  /**
452
- * @beta
452
+ * @public
453
+ * A policy that can modify the incoming HTTP request before it is sent to
454
+ * the handler. If a response is returned, the request is short-circuited and
455
+ * the response is returned to the client. If a Request is returned, policies
456
+ * or a handler that follow are executed.
457
+ *
458
+ * @param request - The incoming Request
459
+ * @param context - The current context of the Request
460
+ * @param options - The configuration options for the policy
461
+ * @param policyName - The name set on the policy in the configuration
462
+ * @returns A Response or Request object
453
463
  */
454
464
  declare interface InboundPolicyHandler<TOptions = any> {
455
465
  (request: ZuploRequest, context: ZuploContext, options: TOptions, policyName: string): Promise<ZuploRequest | Response>;