commit 0525948e78cf50bbd1a3ae65ad5a02e9c04ed132 · kitten.sh/urql

+42
exchanges/request-policy/src/requestPolicyExchange.ts
···

       8
       8
        
       

     

       9
       9
        
       const defaultTTL = 5 * 60 * 1000;

     

       10
       10
        
       

     

       11
       11
       +
       /** Input parameters for the {@link requestPolicyExchange}. */

     

       11
       12
        
       export interface Options {

     

       13
       13
       +
         /** Predicate allowing you to selectively not upgrade `Operation`s.

     

       14
       14
       +
         

     

       15
       15
       +
         @remarks

     

       16
       16
       +
         When `shouldUpgrade` is set, it may be used to selectively return a boolean

     

       17
       17
       +
         per `Operation`. This allows certain `Operation`s to not be upgraded to a

     

       18
       18
       +
         `cache-and-network` policy, when `false` is returned.

     

       19
       19
       +
         

     

       20
       20
       +
         By default, all `Operation`s are subject to be upgraded.

     

       21
       21
       +
          * operation to "cache-and-network". */

     

       12
       22
        
         shouldUpgrade?: (op: Operation) => boolean;

     

       23
       23
       +
         /** The time-to-live (TTL) for which a request policy won't be upgraded.

     

       24
       24
       +
         

     

       25
       25
       +
         @remarks

     

       26
       26
       +
         The `ttl` defines the time frame in which the `Operation` won't be updated

     

       27
       27
       +
         with a `cache-and-network` request policy. If an `Operation` is sent again

     

       28
       28
       +
         and the `ttl` time period has expired, the policy is upgraded.

     

       29
       29
       +
         

     

       30
       30
       +
         @defaultValue `300_000` - 5min

     

       31
       31
       +
         */

     

       13
       32
        
         ttl?: number;

     

       14
       33
        
       }

     

       15
       34
        
       

     

       35
       35
       +
       /** Exchange factory that upgrades request policies to `cache-and-network` for queries outside of a defined `ttl`.

     

       36
       36
       +
        *

     

       37
       37
       +
        * @param options - An {@link Options} configuration object.

     

       38
       38
       +
        * @returns the created request-policy {@link Exchange}.

     

       39
       39
       +
        *

     

       40
       40
       +
        * @remarks

     

       41
       41
       +
        * The `requestPolicyExchange` upgrades query operations based on {@link Options.ttl}.

     

       42
       42
       +
        * The `ttl` defines a timeframe outside of which a query's request policy is set to

     

       43
       43
       +
        * `cache-and-network` to refetch it in the background.

     

       44
       44
       +
        *

     

       45
       45
       +
        * You may define a {@link Options.shouldUpgrade} function to selectively ignore some

     

       46
       46
       +
        * operations by returning `false` there.

     

       47
       47
       +
        *

     

       48
       48
       +
        * @example

     

       49
       49
       +
        * ```ts

     

       50
       50
       +
        * requestPolicyExchange({

     

       51
       51
       +
        *  // Upgrade when we haven't seen this operation for 1 second

     

       52
       52
       +
        *  ttl: 1000,

     

       53
       53
       +
        *  // and only upgrade operations that query the `todos` field.

     

       54
       54
       +
        *  shouldUpgrade: op => op.kind === 'query' && op.query.definitions[0].name?.value === 'todos'

     

       55
       55
       +
        * });

     

       56
       56
       +
        * ```

     

       57
       57
       +
        */

     

       16
       58
        
       export const requestPolicyExchange = (options: Options): Exchange => ({

     

       17
       59
        
         forward,

     

       18
       60
        
       }) => {