ApiDataCacheService | api-data-cache

Type Parameters

Hierarchy

ApiDataCacheService

Constructors

constructor

new ApiDataCacheService<T>(httpProxy: any, url: string, cacheTTL?: number, options?: DataCacheOptions): ApiDataCacheService<T>

- Defined in src/index.ts:81
Create a Cached Data Service.

Type Parameters
- T
Parameters
- httpProxy: any
  
  A class implementing the Angular HtttpClient methods get,patch,post, delete and request.
- url: string
  
  The base CRUD url.
- cacheTTL: number = 100
  
  The data cache time to live. (default 100 seconds, minimum 10 seconds)
- options: DataCacheOptions = {}
  
  Additional endpoint for filtering operations used in the advancedList method.
Returns ApiDataCacheService<T>

Properties

cachedVersionInfo

cachedVersionInfo: {} = {}

Type declaration

[id: string]: any[]

disabledCache

disabledCache: boolean = false

Disable new updates to be cached.

requestHeaders

requestHeaders: {} = {}

Set additional headers to all requests of the service.

Type declaration

serializer

serializer: ((data: any) => {})

Type declaration

- (data: any): {}
- Function to serialize the instance data before sending to serve in the edit() and create() methods.
  
  Parameters
  - data: any
  Returns {}

setFullRecordOnGet

setFullRecordOnGet: boolean = true

By setting the parameter setFullRecordOnGet to true, the retrieved record using the get() method will be automatically marked as full. In this context, 'full' means that the record possesses all fields, including any required nested fields. On the other hand, if setFullRecordOnGet is set to false, the retrieved record will not be marked as 'full'. In this case, you need to add a calculated field _full: true to the fully serialized records on the server-side.

started

started: boolean = false

Is the data service initiated?

url

url: string

Methods

advancedList

advancedList(qsearch?: string, pageRequest?: DataPageRequest, options?: Partial<AdvancedListOptions>, alternativeUrl?: string): Subject<DataListResponse<T>>

- Defined in src/index.ts:395
This method constucts a POST request that retrives a list of selected entity instances. The selecting parameters are passed in the request body through the parameter options. These parameters must be interpreted by the backend. In principle this method should be used in list views where the server would return non-nested or partial objects.
see
list

example
```
// Filtering
 let bakersList = [];
 const options = { filter: {'profession': 'Baker'}};
 service.advancedList('',  options)
 .subscribe( r => bakersList = r.list);

// Inclusion of instances
 let bakersListExtended = [];
 const options = { filter: {'profession': 'Baker'}, includeIds: [3, 4, 5]};
 service.advancedList('',  options)
 .subscribe( r => bakersListExtended = r.list);

 // Fully-nested objects
 let detailedBakersList = [];
 const options = { filter: {'profession': 'Baker'}, fullyNested: true};
 service.advancedList('',  options)
 .subscribe( r => detailedBakersList = r.list);
```
Parameters
- qsearch: string = ''
  
  String query parameter: search string to be processed by the server.
- pageRequest: DataPageRequest = null
  
  Define the pagination properties. Example: { itemsPerPage: 50, page: 2, orderBy: 'last_name' } will be parsed to "http://my_url/?limit=50&page=2&orderBy=last_name&search=qsearch"
- options: Partial<AdvancedListOptions> = null
  
  Selecting parameters passed to the server within the request body.
- alternativeUrl: string = ''
  
  Alternative endpoint URL.
Returns Subject<DataListResponse<T>>
An Observable of the response.

create

create(instance: Partial<T>): Observable<DataCreationResponse<T>>

- Defined in src/index.ts:522
Constructs a POST request to create a new entity record in the server database.

Parameters
- instance: Partial<T>
  
  partial instance of object.
Returns Observable<DataCreationResponse<T>>
An Observable of the response. If the server response includes the data of the created record, this data will be cached.

delete

delete(id: number | DataModel, alternativeUrl?: string): Observable<any>

- Defined in src/index.ts:594
Constructs a PATCH request to update an existing record in the server database.

Parameters
- id: number | DataModel
  
  Unique identifier of the entity record.
- alternativeUrl: string = ''
Returns Observable<any>
An Observable of the response. If the server response includes the data of the created record, this data will update the cache.

deleteOutdatedCache

deleteOutdatedCache(): void

- Defined in src/index.ts:157
Free memory by deleting outdated instances from the cache.

Returns void

edit

edit(instance: Partial<T>, alternativeUrl?: string): Observable<any>

- Defined in src/index.ts:555
Constructs a PATCH request to update an existing instance in the server database.

Parameters
- instance: Partial<T>
  
  partial record of object.
- alternativeUrl: string = ''
Returns Observable<any>
An Observable of the response. If the server response includes the data of the created instance, this data will update the cache.

get

get(id: string | number, reload?: boolean, alternativeUrl?: string): Observable<T>

- Defined in src/index.ts:484
Constructs a GET request that retrieves the entity's fully nested data by its unique identifier (id) and saves it in the data cache, reducing the number of server accesses. The default URL endpoint is used, appended by "/${id}/".

If the property setFullRecordOnGet is set to true, the retrieved record will automatically receive an extra field _full=true, indicating that the record contains all fields and required nested fields. This method will always request the server if the _full field of the record is set to false.

Parameters
- id: string | number
  
  The unique identifier of the entity instance.
- reload: boolean = false
  
  false: Get data from the local cache if available. true: Get data from the server and update the local cache.
- alternativeUrl: string = ''
  
  An alternative endpoint URL.
Returns Observable<T>
An Observable of the service response.

initiateService

initiateService(): void

- Defined in src/index.ts:121
Returns void

list

list(qsearch?: string, pageRequest?: DataPageRequest, alternativeUrl?: string): Subject<any> | Observable<T[] | DataListResponse<T>>

- Defined in src/index.ts:340
Constructs a GET request that retrives a list of entity instances. In principle this method should be used to fetched non-nested or partial objects. The fully nested object could be retrived in the detail view by using the method get().

see
get

Parameters
- qsearch: string = ''
  
  String query parameter: search string to be processed by the server.
- pageRequest: DataPageRequest = null
  
  Define the pagination properties. Example: { itemsPerPage: 50, page: 2, orderBy: 'last_name' } will be parsed to "http://my_url/?limit=50&page=2&orderBy=last_name&search=qsearch"
- alternativeUrl: string = ''
  
  Alternative endpoint URL.
Returns Subject<any> | Observable<T[] | DataListResponse<T>>
An Observable of the response.

markAllOutdated

markAllOutdated(): void

- Defined in src/index.ts:128
Mark all cached data as outdated

Returns void

markOutdated

markOutdated(id: string | number): void

- Defined in src/index.ts:136
Mark cached record as outdated

Parameters
- id: string | number
  
  Instance id to be marked as outdated.
Returns void

resetListResponseCache

resetListResponseCache(): void

- Defined in src/index.ts:252
Delete short-lived server response cache. This data cache is only used for listing, common in pagination operations.

Returns void

searchCache

searchCache(qsearch: string, scopeIds?: number[]): any[]

- Defined in src/index.ts:230
Search instances locally.

Parameters
- qsearch: string
  
  String to search in the object fields.
- scopeIds: number[] = []
  
  Limiting search to specific collection of ids.
Returns any[]
The cached items that matches the search input.

updateItemsMetaCache

updateItemsMetaCache(items: any[], updatingTime?: any): T[]

- Defined in src/index.ts:214
Parameters
- items: any[]
- updatingTime: any = null
Returns T[]

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

Parameters

httpProxy: any

url: string

cacheTTL: number = 100

options: DataCacheOptions = {}

Returns ApiDataCacheService<T>

Properties

cachedVersionInfo

Type declaration

[id: string]: any[]

disabledCache

requestHeaders

Type declaration

serializer

Type declaration

Parameters

data: any

Returns {}

setFullRecordOnGet

started

url

Methods

advancedList

Parameters

qsearch: string = ''

pageRequest: DataPageRequest = null

options: Partial<AdvancedListOptions> = null

alternativeUrl: string = ''

Returns Subject<DataListResponse<T>>

create

Parameters

instance: Partial<T>

Returns Observable<DataCreationResponse<T>>

delete

Parameters

id: number | DataModel

alternativeUrl: string = ''

Returns Observable<any>

deleteOutdatedCache

Returns void

edit

Parameters

instance: Partial<T>

alternativeUrl: string = ''

Returns Observable<any>

get

Parameters

id: string | number

reload: boolean = false

alternativeUrl: string = ''

Returns Observable<T>

initiateService

Returns void

list

Parameters

qsearch: string = ''

pageRequest: DataPageRequest = null

alternativeUrl: string = ''

Returns Subject<any> | Observable<T[] | DataListResponse<T>>

markAllOutdated

Returns void

markOutdated

Parameters

id: string | number

Returns void

resetListResponseCache

Returns void

searchCache

Parameters