wretch middlewares

Несчастное промежуточное ПО

Коллекция промежуточного программного обеспечения для библиотеки Wretch.

Уведомление об устаревании

️ Этот репозиторий устарел, промежуточное программное обеспечение интегрировано в основной пакет wretch , начиная с версии Wretch v2.0.0.

Установка

Предварительное условие: установить Негодяя.

Нпм

npm i wretch-middlewares

CDN

 <!-- Global variable name : window.wretchMiddlewares -->
< script src =" https://unpkg.com/wretch-middlewares " > </ script >

Промежуточное ПО

Дедуп	Повторить попытку	Регулирование кэша	Задерживать

Дедуп

Предотвращает одновременное выполнение нескольких одинаковых запросов на лету.

Параметры

• пропустить : (url, opts) => boolean

Если пропуск возвращает true, проверка дедупликации пропускается.

• ключ : (url, opts) => string

Возвращает ключ, который используется для идентификации запроса.

• преобразователь : (response: Response) => Response

Эта функция вызывается при разрешении ответа на выборку из повторяющихся вызовов. По умолчанию он клонирует ответ, чтобы можно было прочитать тело из нескольких источников.

Использование

 import wretch from 'wretch'
import { dedupe } from 'wretch-middlewares'

wretch ( ) . middlewares ( [
    dedupe ( {
        /* Options - defaults below */
        skip : ( url , opts ) => opts . skipDedupe || opts . method !== 'GET' ,
        key : ( url , opts ) => opts . method + '@' + url ,
        resolver : response => response . clone ( )
    } )
] ) . /* ... */ 

Повторить попытку

Повторяет запрос несколько раз в случае ошибки (или до тех пор, пока не выполнится пользовательское условие).

Параметры

• задержкаTimer : milliseconds

Таймер между каждой попыткой.

• задержкаRamp : (delay, nbOfAttempts) => milliseconds

Пользовательская функция, которая используется для расчета фактической задержки на основе таймера и количества попыток.

• maxAttempts : number

Максимальное количество повторов перед разрешением обещания с последней ошибкой. Указание 0 означает бесконечное количество повторов.

• до тех пор, пока : (fetchResponse, error) => boolean | Promise<boolean>

Запрос будет повторяться до тех пор, пока это условие не будет выполнено.

• onRetry : ({ response, error, url, options }) => { url?, options? } || Promise<{url?, options?}>

Обратный вызов, который будет выполнен перед повторной попыткой запроса. Если эта функция возвращает объект, имеющий свойства URL и/или параметров, они переопределят существующие значения в повторном запросе. Если он возвращает обещание, его будут ожидать перед повторной попыткой запроса.

• retryOnNetworkError : boolean

Если это правда, повторит запрос, если возникла сетевая ошибка. Также будет предоставлен аргумент «ошибка» для методов onRetry и until .

• преобразователь : (response: Response) => Response

Эта функция вызывается при разрешении ответа на выборку из повторяющихся вызовов. По умолчанию он клонирует ответ, чтобы можно было прочитать тело из нескольких источников.

Использование

 import wretch from 'wretch'
import { retry } from 'wretch-middlewares'

wretch ( ) . middlewares ( [
    retry ( {
        /* Options - defaults below */
        delayTimer : 500 ,
        delayRamp : ( delay , nbOfAttempts ) => delay * nbOfAttempts ,
        maxAttempts : 10 ,
        until : ( response , error ) => response && response . ok ,
        onRetry : null ,
        retryOnNetworkError : false ,
        resolver : response => response . clone ( )
    } )
] ) . /* ... */

// You can also return a Promise, which is useful if you want to inspect the body:
wretch ( ) . middlewares ( [
    retry ( {
        until : response =>
            response . json ( ) . then ( body =>
                body . field === 'something'
            )
    } )
] ) 

Регулирование кэша

Кэш регулирования, который сохраняет и обслуживает ответы сервера в течение определенного периода времени.

Параметры

• дроссель : milliseconds

Ответ будет храниться в течение этого времени, прежде чем будет удален из кэша.

• пропустить : (url, opts) => boolean

Если пропуск возвращает true, проверка дедупликации пропускается.

• ключ : (url, opts) => string

Возвращает ключ, который используется для идентификации запроса.

• очистить (url, opts) => boolean

Очищает кеш, если это правда.

• сделать недействительным (url, opts) => string | RegExp | Array<string | RegExp> | null

Удаляет URL-адреса, соответствующие строке или RegExp, из кеша. Можно использовать массив для признания недействительными нескольких значений.

• ответ на условие response => boolean

Если false, то ответ не будет добавлен в кеш.

• string flagResponseOnCacheHit

Если этот параметр установлен, ответ, возвращенный из кэша, будет помечен именем свойства, равным этому параметру.

Использование

 import wretch from 'wretch'
import { throttlingCache } from 'wretch-middlewares'

wretch ( ) . middlewares ( [
    throttlingCache ( {
        /* Options - defaults below */
        throttle : 1000 ,
        skip : ( url , opts ) => opts . skipCache || opts . method !== 'GET' ,
        key : ( url , opts ) => opts . method + '@' + url ,
        clear : ( url , opts ) => false ,
        invalidate : ( url , opts ) => null ,
        condition : response => response . ok ,
        flagResponseOnCacheHit : '__cached'
    } )
] ) . /* ... */ 

Задерживать

Задерживает запрос на определенное время.

Параметры

• время : milliseconds

Запрос будет задержан на это время.

Использование

 import wretch from 'wretch'
import { delay } from 'wretch-middlewares'

wretch ( ) . middlewares ( [
    delay ( 1000 )
] ) . /* ... */