Store: [Feature] Reset state to default

[garthmason]

Feature Request - reset a state to default

I've found that in a few scenarios (log out, switch account etc) it'd be useful to be able to easily reset a state to its default values.

So for a state like this:

export interface MyStateModel {
    name: string;
    rating: number;
}

@State<MyStateModel>(
{   
   name: 'myState',
   defaults: {
       name: '',
       rating: 1
  }
})
export class MyState { .. }

I could write something like:

@Action(LogOutComplete)
onLogOut({reset}: StateContext<MyStateModel>) {
    reset();
}

Currently, I'm writing like this, duplicating my defaults definition.

@Action(LogOutComplete)
onLogOut({setState}: StateContext<MyStateModel>) {
    setState({
      name: '',
      rating: 1
   });
}

This is distinct from the store.reset function that was recently added.

[eranshmil]

You can change all properties to optional in the model and then use setState({}) or use a const for the defaults, just like in my example in the pr #501.

[amcdnl]

Ya, I agree. That is the appropriate way to handle this.

[garthmason]

@eranshmil that's great, thanks for the tip! The const for defaults would suit us, I'll refactor it that way 👍

[goodmite]

hey @amcdnl and @eranshmil
Thanks for your answers. I went through #501. If I understood correctly, are you suggesting that we should write state resetters (to default) for each substate?
I currently have 5 substates in my project, do I need to write reset action for all of these 5 states? That will be a bit tedious imho. Sorry if I misunderstood anything.
Thanks.

[eranshmil]

If you want to clear the whole store state, you can use meta reducers.
https://ngxs.gitbook.io/ngxs/advanced/meta-reducer

The defaults way used only to clear a specific state.