simplify mental model of store creation

[DmitryEfimenko]

I don't quite understand why by default elf requires a developer to create a state and a store in two separate steps.
When I saw the documentation for the first time, I found it quite confusing that the createState function returns a state and config objects that then need to be passed into the Store constructor.

const { state, config } = createState(withProps<AuthProps>({ user: null }));

const authStore = new Store({ state, name: 'auth', config });

If I'm not mistaken, the state and config variables are not expected to be used for anything else except for instantiating the store.
It's possible I'm missing something. In that case, please elaborate.

I think elf would be much easier to understand if instead we had a single function to call: createStore:

interface StoreConfig {
  name: string;
  deepFreeze?: <T>(o: T) => T;
}

function createStore<S>(storeConfig: StoreConfig, ...propsFactories: S) {
  const { state, config } = createState(propsFactories);
  const { name, deepFreeze }  = storeConfig;

  return new Store({ state, name, config, deepFreeze });
}

Usage:

const store = createStore(
  { name: 'auth' },
  withProps<AuthProps>({ user: null })
);

It's a super short function - just a wrapper really. I understand that I could simply add it to my project and call it a day, but I feel like elf would be much easier to understand for everyone else if we include this function in the elf itself and update docs to encourage people to use it.

This also would not be a breaking change.

[NetanelBasal]

It was meant to be able to create an entire shared state. Anyway, you're welcome to add this function to the library.

[DmitryEfimenko]

Do you mind telling me more? What's the use case?

[NetanelBasal]

Composable states.

[DmitryEfimenko]

Is there an example of that documented somewhere?

[NetanelBasal]

No