@zuplo/graphql 5.1796.0 → 5.1800.0

package/index.d.ts

@@ -449,7 +449,17 @@ declare enum HttpStatusCode {
 declare type HttpStatusCodeRangeDefinition = "1XX" | "2XX" | "3XX" | "4XX" | "5XX";
 
 /**
- * @beta
+ * @public
+ * A policy that can modify the incoming HTTP request before it is sent to
+ * the handler. If a response is returned, the request is short-circuited and
+ * the response is returned to the client. If a Request is returned, policies
+ * or a handler that follow are executed.
+ *
+ * @param request - The incoming Request
+ * @param context - The current context of the Request
+ * @param options - The configuration options for the policy
+ * @param policyName - The name set on the policy in the configuration
+ * @returns A Response or Request object
  */
 declare interface InboundPolicyHandler<TOptions = any> {
     (request: ZuploRequest, context: ZuploContext, options: TOptions, policyName: string): Promise<ZuploRequest | Response>;
@@ -634,6 +644,10 @@ declare interface RouteConfiguration extends Omit<BuildRouteConfiguration, "raw"
 
 declare type UserDataDefault = any;
 
+declare interface WaitUntilFunc {
+    (promise: Promise<any>): void;
+}
+
 /**
  * @beta
  */
@@ -653,7 +667,7 @@ declare interface ZuploContext extends EventTarget {
     readonly custom: Record<string, any>;
     readonly incomingRequestProperties: IncomingRequestProperties;
     readonly invokeInboundPolicy: (policyName: string, request: ZuploRequest) => Promise<Response | ZuploRequest>;
-    readonly waitUntil: (promise: Promise<any>) => void;
+    readonly waitUntil: WaitUntilFunc;
     /**
      * Fires just before the response is sent. Response can be modified.
      */