Class CachingUrlFetcher

The default URL fetcher that Dockta uses. Fetches using got and caches results using persist

Hierarchy

CachingUrlFetcher

Implements

UrlFetcher

Index

Methods

Methods

fetchUrl

fetchUrl(url: string, options?: any): Promise<any>

Implementation of UrlFetcher.fetchUrl
- Defined in src/CachingUrlFetcher.ts:19
Fetch a URL using got, attempting to retrieve it from cache first.

Parameters
- url: string
- Default value options: any = { responseType: 'json' }
Returns Promise<any>

Static getFromCache

getFromCache(url: string): Promise<any>

- Defined in src/CachingUrlFetcher.ts:61
Try to get a result from the persist cache. This method with initialise the persist cache if it has not been set up.

Parameters
- url: string
Returns Promise<any>

Static setToCache

setToCache(url: string, value: any): Promise<void>

- Defined in src/CachingUrlFetcher.ts:87
Set a value (URL response body, usually) to the persist cache.

Parameters
- url: string
- value: any
Returns Promise<void>

Generated using TypeDoc