Class CachingWebClient

An asynchronous cache aware HTTP / HTTP/2 client called CachingWebClient.

This client wraps a WebClient and makes it cache aware by adding features to it:

Cache-Control header parsing
Freshness checking

The client honors the following cache headers:

Cache-Control with the following properties understood:
- public
- private
- no-cache
- no-store
- max-age
- s-maxage
- stale-if-error
- staile-while-revalidate
- must-revalidate
Expires
ETag
Vary

Hierarchy

CachingWebClient

Index

Methods

create

Methods

Static create

create(webClient: WebClient): WebClient
create(webClient: WebClient, cacheStore: any): WebClient
create(webClient: WebClient, options: CachingWebClientOptions): WebClient
create(webClient: WebClient, cacheStore: any, options: CachingWebClientOptions): WebClient

- Defined in io.vertx/vertx-web-client/target/npm/index.d.ts:55
Create a cache aware web client using the provided WebClient.

Parameters
- webClient: WebClient
Returns WebClient
- Defined in io.vertx/vertx-web-client/target/npm/index.d.ts:60
Create a cache aware web client using the provided WebClient.

Parameters
- webClient: WebClient
- cacheStore: any
Returns WebClient
- Defined in io.vertx/vertx-web-client/target/npm/index.d.ts:65
Create a cache aware web client using the provided WebClient.

Parameters
- webClient: WebClient
- options: CachingWebClientOptions
Returns WebClient
- Defined in io.vertx/vertx-web-client/target/npm/index.d.ts:70
Create a cache aware web client using the provided WebClient.

Parameters
- webClient: WebClient
- cacheStore: any
- options: CachingWebClientOptions
Returns WebClient

Generated using TypeDoc