TrebleGSM

API Reference

The API references below are methods that are built into the TrebleGSM library.

Creates a new TrebleGSM store.

createStore(storeData, options);

Creates a new TrebleGSM module.

createModule(moduleData);

Higher order function that allows components to connect to a TrebleGSM store. It is also used to connect Class Components to a TrebleGSM store.

withTreble(Component, options);

A Hook that exposes the TrebleGSM store state and store dispatchers to the component it is initialized in.

useTreble(context);

Creates a new TrebleGSM context for scoping stores.

useScopedTreble();

Provider component that wraps around components and gives them access to the TrebleGSM store.

<Treble store>{children}</Treble>

A raw provider component that can be used to create custom Treble provider components.

<Provider reducer initialState scope store modules>{children}</Provider>