Rocket Logo Stoxy Docs Guides Toggle darkmode

Methods: Read

Get the state object data from Stoxy.

Returns a promise, which when resolved contains the state object data.


keyKey in string form. Used as the name of the state object


A promise which resolves to the read result of the object: {any}


import { read } from '@stoxy/core';

read('shoppingcart').then(shoppingCartItems => { => console.log(item));
import { read } from '@stoxy/core';

async function getItems() {
    const items = await read('shoppingcart');
    return items;

Specific read

You can also read a property of a state object just as easily as you would the whole state object

This is exteremely handy when you don't need the whole state object at the same time.

With a state object like

const userData = {
    userName: "Stoxy",
    shoppingCart: [
        { id: 123, name: "Flaming hot cheetos" }
    shoppingHistory: {
        latestProducts: [
            { id: 555, name: "Doritos" },
            { id: 958, name: "Pringles" }

One could access the latest products in the shoppinghistory of the user with

import { read } from '@stoxy/core';

read("userData.shoppingHistory.latestProducts").then(latestHistoryProducts => { => console.log(item));