#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# DataSourceCacheExtension Class

Defined in: `datasource/js/datasource-cache.js:8`
Module: datasource-cache
Parent Module: datasource

DataSourceCache extension binds Cache to DataSource.

- Index
- Methods
- Properties

## Item Index

### Methods

- _beforeDefRequestFn
- _beforeDefResponseFn
- initializer

### Properties

- NAME static
- NS static

## Methods

### `_beforeDefRequestFn`

(

- `e`

)
protected

Defined in `datasource/js/datasource-cache.js:53`

First look for cached response, then send request to live data.

#### Parameters:

- `e` Event.Facade

  Event Facade with the following properties:

  tId (Number)
    Unique transaction ID.
  request (Object)
    The request.
  callback (Object)
    The callback object.
  cfg (Object)
    Configuration object.

### `_beforeDefResponseFn`

(

- `e`

)
protected

Defined in `datasource/js/datasource-cache.js:82`

Adds data to cache before returning data.

#### Parameters:

- `e` Event.Facade

  Event Facade with the following properties:

  tId (Number)
    Unique transaction ID.
  request (Object)
    The request.
  callback (Object)
    The callback object with the following properties:
    success (Function)
      Success handler.
    failure (Function)
      Failure handler.
  data (Object)
    Raw data.
  response (Object)
    Normalized response object with the following properties:
    cached (Object)
      True when response is cached.
    results (Object)
      Parsed results.
    meta (Object)
      Parsed meta data.
    error (Object)
      Error object.
  cfg (Object)
    Configuration object.

### `initializer`

(

- `config`

)
private

Defined in `datasource/js/datasource-cache.js:41`

Internal init() handler.

#### Parameters:

- `config` Object

  Config object.

## Properties

### `NAME`

String final static

Defined in `datasource/js/datasource-cache.js:28`

Class name.

### `NS`

String final static

Defined in `datasource/js/datasource-cache.js:16`

The namespace for the plugin. This will be the property on the host which references the plugin instance.