@ngx-cache/platform-server
v9.0.0
Published
Server platform implementation of ngx-cache
Downloads
708
Maintainers
Readme
@ngx-cache/platform-server
Server platform implementation of ngx-cache
Please support this project by simply putting a Github star. Share this library with friends on Twitter and everywhere else you can.
Table of contents:
Getting started
Installation
You can install @ngx-cache/platform-server
using npm
npm install @ngx-cache/platform-server --save
Note: You should have already installed @ngx-cache/core.
Note: You should have also installed @ngx-cache/fs-storage (which is currently the only available storage on the server platform).
Examples
- ng-seed/universal is an officially maintained seed project, showcasing common patterns and best practices for
@ngx-cache/platform-server
.
Related packages
The following packages may be used in conjunction with @ngx-cache/platform-server
:
Adding @ngx-cache/platform-server
to your project (SystemJS)
Add map
for @ngx-cache/platform-server
in your systemjs.config
'@ngx-cache/platform-server': 'node_modules/@ngx-cache/platform-server/bundles/platform-server.umd.min.js'
app.module configuration
- Import
ServerCacheModule
using the mapping'@ngx-cache/platform-server'
and appendServerCacheModule.forRoot({...})
within the imports property of app.server.module (considering the app.server.module is the server module in Angular Universal application). - Import
CACHE
injection token using the mapping'@ngx-cache/core'
,FsCacheService
using the mapping'@ngx-cache/platform-server'
. - Provide
CACHE
usingFsCacheService
, by calling the forRoot static method using theServerCacheModule
. - Import
STORAGE
injection token using the mapping'@ngx-cache/core'
,FsStorageService
using the mapping'@ngx-cache/fs-storage'
. - Provide
STORAGE
usingFsStorageService
, by calling the forRoot static method using theServerCacheModule
. - Import
FsStorageLoader
andfsStorageFactory
using the mapping'@ngx-cache/fs-storage'
. - Provide
FsStorageLoader
usingfsStorageFactory
, by calling the forRoot static method using theServerCacheModule
. - Pass
CacheService
together withApplicationRef
andTransferState
to the implementation ofbootstrapFactory
method below.
app.server.module.ts
...
import { CacheService, CACHE, STORAGE } from '@ngx-cache/core';
import { ServerCacheModule, FsCacheService } from '@ngx-cache/platform-server';
import { fsStorageFactory, FsStorageLoader, FsStorageService } from '@ngx-cache/fs-storage';
...
export function bootstrapFactory(appRef: ApplicationRef,
transferState: TransferState,
cache: CacheService): () => Subscription {
return () => appRef.isStable
.filter(stable => stable)
.first()
.subscribe(() => {
transferState.set<any>(makeStateKey(cache.key), JSON.stringify(cache.dehydrate()));
});
}
@NgModule({
declarations: [
AppComponent,
...
],
...
imports: [
...
ServerCacheModule.forRoot([
{
provide: CACHE,
useClass: FsCacheService
},
{
provide: STORAGE,
useClass: FsStorageService
},
{
provide: FsStorageLoader,
useFactory: (fsStorageFactory)
}
]),
],
...
providers: [
{
provide: APP_BOOTSTRAP_LISTENER,
useFactory: (bootstrapFactory),
multi: true,
deps: [
ApplicationRef,
TransferState,
CacheService
]
}
],
bootstrap: [AppComponent]
})
export class AppServerModule {
}
:+1: Yeah!
@ngx-cache/platform-server
will now provide server platform implementation to @ngx-cache/core.
Credits
- universal-starter: Angular 2 Universal starter kit by @AngularClass
License
The MIT License (MIT)
Copyright (c) 2019 Burak Tasci