Nuxt.js: Use initialState instead of state when exporting in modules mode

[simonsmith]

What problem does this feature solve?

The issue I've encountered is this:

export const state = () => ({
  someState: 'foo',
});

export const actions = {
  ACTION({ dispatch, commit }) {

    // I forgot to destructure state in the function arguments
    // so now I'm accessing the state function by accident

    if (state.something) {
      // .. never true
    }
  }
};

What does the proposed changes look like?

Allow state to be exported as initialState:

export const initialState = () => ({
  someState: 'foo',
});

export const actions = {
  ACTION({ dispatch, commit }) {

    // Error can now be picked up by ESLint or will 
    // throw an error with state being undefined
  }
};

_{This feature request is available on Nuxt community (#c7851)}

[felubra]

I'd like to help with this issue 😊

[felubra]

Question: should we deprecate the old behavior, the export using the 'state' function name? Or should we use both - check for a 'state' function then check for a 'initialState' function?

[simonsmith]

Perhaps deprecate the state export but support both for now and then remove state in a future release to give plenty of time for migration

[felubra]

@manniL I would appreciate hearing your opinion on this, thanks!

[manniL]

@felubra Sorry, somehow I missed the notifications from that issue 🤔

I would not deprecate state because the default VueX initialization structure should still work. It’d be a nice addition to accept initialState as well

[manniL]

As stated in #4096, this feature won't see the daylight.

Thanks for your efforts @felubra! :pray:

[cmty[bot]]

This feature-request has been cancelled by @manniL.

[lock[bot]]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.