Class: ApiRequest

Members

---

<static, readonly> DEFAULT_CACHE_NAMESPACE :String

Type:

• String

Source:

• api-request/modules/api-request/index.js, line 22

Methods

---

addCacheManager(namespace, expire)

Parameters:

Name	Type	Description
namespace	String
expire	Number

Source:

• api-request/modules/api-request/index.js, line 48

---

addFormatter(format, formatter)

addformatter() adds a new format to formatter's list.

Parameters:

Name	Type	Description
format	String	name for the formatter
formatter	FormatterManager	formatter object

Source:

• api-request/modules/api-request/index.js, line 40

---

clearCache(namespace)

Clears cached data by namespace.

Parameters:

Name	Type	Description
namespace	String	cache namespace

Source:

• api-request/modules/api-request/index.js, line 130

---

getCacheManager(namespace, expire)

Returns an existing cacheManager if it exists or creates a new one and assigns it to the namespace.

Parameters:

Name	Type	Description
namespace	String	cache namespace
expire	Number

Source:

• api-request/modules/api-request/index.js, line 62

Returns:

Type

CacheManager

---

purgeCache(namespace)

Parameters:

Name	Type	Description
namespace	String

Source:

• api-request/modules/api-request/index.js, line 87

---

request(url, payload, format, fromCache, namespace)

Makes a network call using fetch API.

Parameters:

Name	Type	Default	Description
url	String		request url
payload	*		data
format	String		formatter name
fromCache	Boolean	true	fetch new data or return cached
namespace	String	default	cache manager namespace

Source:

• api-request/modules/api-request/index.js, line 109

Returns:

Type

Promise

---

updateCacheInterval(namespace, expire)

Update a cache managers expire time

Parameters:

Name	Type	Description
namespace	String
expire	Number

Source:

• api-request/modules/api-request/index.js, line 78