Life-cycle

Search…
Life-cycle
States can implement life-cycle events.
ngxsOnChanges
If a state implements the NgxsOnChanges interface, its ngxsOnChanges method respond when (re)sets state. The states' ngxsOnChanges methods are invoked in a topological sorted order going from parent to child. The first parameter is the NgxsSimpleChange object of current and previous state.
1
export interface ZooStateModel {
2
  animals: string[];
3
}
4
​
5
@State<ZooStateModel>({
6
  name: 'zoo',
7
  defaults: {
8
    animals: []
9
  }
10
})
11
@Injectable()
12
export class ZooState implements NgxsOnChanges {
13
  ngxsOnChanges(change: NgxsSimpleChange) {
14
    console.log('prev state', change.previousValue);
15
    console.log('next state', change.currentValue);
16
  }
17
}
Copied!
ngxsOnInit
If a state implements the NgxsOnInit interface, its ngxsOnInit method will be invoked after all the states from the state's module definition have been initialized and pushed into the state stream. The states' ngxsOnInit methods are invoked in a topological sorted order going from parent to child. The first parameter is the StateContext where you can get the current state and dispatch actions as usual.
1
export interface ZooStateModel {
2
  animals: string[];
3
}
4
​
5
@State<ZooStateModel>({
6
  name: 'zoo',
7
  defaults: {
8
    animals: []
9
  }
10
})
11
@Injectable()
12
export class ZooState implements NgxsOnInit {
13
  ngxsOnInit(ctx: StateContext<ZooStateModel>) {
14
    console.log('State initialized, now getting animals');
15
    ctx.dispatch(new GetAnimals());
16
  }
17
}
Copied!
ngxsAfterBootstrap
If a state implements the NgxsAfterBootstrap interface, its ngxsAfterBootstrap method will be invoked after the root view and all its children have been rendered, because Angular invokes functions, retrieved from the injector by APP_BOOTSTRAP_LISTENER token, only after creating and attaching ComponentRef of the root component to the tree of views.
1
export interface ZooStateModel {
2
  animals: string[];
3
}
4
​
5
@State<ZooStateModel>({
6
  name: 'zoo',
7
  defaults: {
8
    animals: []
9
  }
10
})
11
@Injectable()
12
export class ZooState implements NgxsAfterBootstrap {
13
  ngxsAfterBootstrap(ctx: StateContext<ZooStateModel>) {
14
    console.log('The application has been fully rendered');
15
    ctx.dispatch(new GetAnimals());
16
  }
17
}
Copied!
Lifecycle sequence
After creating the state by calling its constructor, NGXS calls the lifecycle hook methods in the following sequence at specific moments:
Hook
Purpose and Timing
ngxsOnChanges()
Called before ngxsOnInit() and whenever state changes.
ngxsOnInit()
Called once, after the first ngxsOnChanges() and before the APP_INITIALIZER token is resolved.
ngxsAfterBootstrap()
Called once, after the root view and all its children have been rendered.
Feature Modules Order of Imports
If you have feature modules they need to be imported after the root module:
1
// feature.module.ts
2
@NgModule({
3
  imports: [NgxsModule.forFeature([FeatureState])]
4
})
5
export class FeatureModule {}
6
​
7
// app.module.ts
8
@NgModule({
9
  imports: [NgxsModule.forRoot([]), FeatureModule]
10
})
11
export class AppModule {}
Copied!
APP_INITIALIZER Stage
Theoretical Introduction
The APP_INITIALIZER is just a token that references Promise factories. If you've ever used the APP_INITIALIZER token, then you are already familiar with its syntax:
1
export function appInitializerFactory() {
2
  return () => Promise.resolve();
3
}
4
​
5
@NgModule({
6
  providers: [
7
    {
8
      provide: APP_INITIALIZER,
9
      useFactory: appInitializerFactory,
10
      multi: true
11
    }
12
  ]
13
})
14
export class AppModule {}
Copied!
This token is injected into ApplicationInitStatus class. What does Angular do under the hood? It gets an instance of this class and invokes the runInitializers method:
1
const initStatus = moduleRef.injector.get(ApplicationInitStatus);
2
initStatus.runInitializers();
Copied!
All that it does inside this method is looping via the APP_INITIALIZER array (as it's a multi token) and invoking those factories, that you've provided in useFactory properties:
1
for (let i = 0; i < this.appInits.length; i++) {
2
  const initResult = this.appInits[i]();
3
  if (isPromise(initResult)) {
4
    asyncInitPromises.push(initResult);
5
  }
6
}
Copied!
Then asyncInitPromises are provided into Promise.all. That's all the magic. That's why the bootstrapModule returns a Promise:
1
platformBrowser()
2
  .bootstrapModule(AppModule)
3
  .then(() => {
4
    console.log('Hey there!');
5
  });
Copied!
APP_INITIALIZER and NGXS
Everything that we examined earlier is very important, because from this comes the fact that APP_INITIALIZER is resolved after NGXS states are initialized. They are initialized by the NgxsModule that is imported into the AppModule. The ngxsOnInit method on states is also invoked before the APP_INITIALIZER token is resolved. Given the following code:
1
@Injectable({ providedIn: 'root' })
2
export class ConfigService {
3
  private version: string | null = null;
4
​
5
  constructor(private http: HttpClient) {}
6
​
7
  loadVersion(): Observable<string> {
8
    return this.http.get<string>('/api/version').pipe(
9
      tap(version => {
10
        this.version = version;
11
      })
12
    );
13
  }
14
​
15
  getVersion(): never | string {
16
    if (this.version === null) {
17
      throw new Error('"version" is not available yet!');
18
    }
19
​
20
    return this.version;
21
  }
22
}
23
​
24
@State<string | null>({
25
  name: 'version',
26
  defaults: null
27
})
28
@Injectable()
29
export class VersionState implements NgxsOnInit {
30
  constructor(private configService: ConfigService) {}
31
​
32
  ngxsOnInit(ctx: StateContext<string | null>) {
33
    ctx.setState(this.configService.getVersion());
34
  }
35
}
36
​
37
export function appInitializerFactory(configService: ConfigService) {
38
  return () => configService.loadVersion().toPromise();
39
}
40
​
41
@NgModule({
42
  imports: [NgxsModule.forRoot([VersionState])],
43
  providers: [
44
    {
45
      provide: APP_INITIALIZER,
46
      useFactory: appInitializerFactory,
47
      multi: true,
48
      deps: [ConfigService]
49
    }
50
  ]
51
})
52
export class AppModule {}
Copied!
The above example is used only for demonstration purposes! This code will throw an error because the getVersion method is invoked before the version property is set. Why? Because the ngxsOnInit methods on states are invoked before the APP_INITIALIZER is invoked!
Solution
There are different solutions. Let's look at the simplest. The first solution would be to use the ngxsAfterBootstrap method:
1
@State<string | null>({
2
  name: 'version',
3
  defaults: null
4
})
5
@Injectable()
6
export class VersionState implements NgxsAfterBootstrap {
7
  constructor(private configService: ConfigService) {}
8
​
9
  ngxsAfterBootstrap(ctx: StateContext<string | null>) {
10
    ctx.setState(this.configService.getVersion());
11
  }
12
}
Copied!
The second solution would be dispatching some SetVersion action right after the version is fetched:
1
export class SetVersion {
2
  static readonly type = '[Version] Set version';
3
  constructor(public version: string) {}
4
}
5
​
6
@State<string | null>({
7
  name: 'version',
8
  defaults: null
9
})
10
@Injectable()
11
export class VersionState {
12
  @Action(SetVersion)
13
  setVersion(ctx: StateContext<string | null>, action: SetVersion): void {
14
    ctx.setState(action.version);
15
  }
16
}
17
​
18
@Injectable({ providedIn: 'root' })
19
export class ConfigService {
20
  constructor(private http: HttpClient, private store: Store) {}
21
​
22
  loadVersion() {
23
    return this.http.get<string>('/api/version').pipe(
24
      tap(version => {
25
        this.store.dispatch(new SetVersion(version));
26
      })
27
    );
28
  }
29
}
Copied!
Summary
In conclusion, do not try to access any data in state constructors or ngxsOnInit methods that is fetched during the APP_INITIALIZER stage.